NetSuite の始め方| N/record: Column.isSortableプロパティ

前の記事NetSuiteの始め方| Understanding SuiteScript 2.x Modulesで、レコードの操作に使用されるSuiteScriptモジュールおよびN/recordモジュールNetSuiteの始め方| N/record Module Overviewを調査しました。次に、N/record: Column.isSortable Propertyのメンバーの1つを詳しく確認します。

Column.isSortableは、search.Columnオブジェクトのブール型プロパティです。orderBy句で列を使用できるか、SuiteScript検索の結果をソートできるかを示します。

• true - 列はソートをサポートします。
• false - 列はソートをサポートしていません。

これは、検索を動的に構築する場合や、orderBy句で列を安全に使用できるかどうかを検証する場合に特に役立ちます。

SuiteScript検索を操作する場合、すべてのフィールドでソートがサポートされるわけではありません。ソート不可能な列でソートしようとすると、予期しない動作またはエラーが発生する可能性があります。

isSortableを使用すると、次のことができます。

• ソートを適用する前に列を検証
• より安全で動的な検索ロジックの構築
• 実行時の問題の回避

使用例

次に、列がソート可能かどうかを確認する方法を示す簡単な例を示します。

/**
 * @NApiVersion 2.x
 * @NScriptType ScheduledScript 
 */
define(['N/search','N/record', 'N/log'], function(search, record, log) {

    function execute(context) {

        // 顧客レコードの検索の作成
        var mySearch = search.create({
            type: search.Type.CUSTOMER,

            // 返す列を定義
            columns: [
                search.createColumn({
                    name: 'entityid' // Customer Name / ID field
                })
            ]
        });

        // 検索の最初の列にアクセス
        var col = mySearch.columns[0];

        // Column.isSortableは読み取り専用のブール型プロパティー
        //この列がソートをサポートしているかどうかを示します
        // true = ソート可能
        // false = ソートできません
        var isSortable = col.isSortable;

        // 結果を実行ログに記録
        log.debug({
            title: 'Is Sortable?',
            details: isSortable
        });

        // オプション: 安全な使用法を示す
        if (isSortable) {
            log.debug({
                title: 'Info',
                details: 'You can safely apply sorting to this column.'