Constant オブジェクト

定数値管理オブジェクト。

定数値を管理するAPIです。
メソッド define()で設定された値は、Constant オブジェクトのプロパティ値としてプロセス内のすべてのファンクション・コンテナから変更不能な定数値として参照することができます。
このAPIの設定値は、Application Runtime の動作しているサーバ・プロセスをスコープとして管理されます。他のサーバ・プロセスから参照(値の共有)をすることはできません。
また、プロセスが終了するまで値の参照は保証されます(プロセスが終了した場合は、値も破棄されます)。


このオブジェクトの同一プロパティ(key)に対して定数値の二重定義はできません。
バージョン:1.0
導入されたバージョン:2.11

メソッドの概要
static void define(String key ,String value)
定数値を設定します。
static void load(String src)
定数値設定ファイルを読込ます。

メソッドの詳細
define

static void define(String key ,String value)

定数値を設定します。

システムで共通の定数値を設定します。
引数 key で指定した文字列が Constant オブジェクトのプロパティとなり、設定後は Constant オブジェクトを介して key で指定されたプロパティにより定数値 value を参照できるようになります。

Constant.key == value

例:
Constant.define("product_name", "intra-mart");
Debug.browse(Constant.product_name);

画面には、変数の内容として intra-mart が表示されます。
パラメータ
key String 定数値参照名称
value String 定数値
返却値
void

load

static void load(String src)

定数値設定ファイルを読込ます。

指定ファイル内に定義されたシステムで共通の定数値を設定します。
引数には、ファイルのラベル名称を指定して下さい。
設定ファイル内には、通常のファンクション・コンテナを作成する要領で、グローバル変数を定義して下さい。
グローバル変数の宣言は初期化(初期値代入)を伴うように記述して下さい。グローバル変数に対して初期値が設定されていない場合、正しく定数値を設定することができません。

定義ファイルが読み込まれた後は、定義ファイル内のグローバル変数名が Constant オブジェクトのプロパティ名称となり、グローバル変数値が定数値として設定されます。

Constant.変数名 == 変数値


例:
定義ファイル(test.js)
var SUN = 0;
var MON = 1;
var TUE = 2;
var WED = 3;
var THU = 4;
var FRI = 5;
var SAT = 6;
ファンクション・コンテナ

Constant.load("test");
Debug.browse(Constant.WED);


画面には、変数の内容として 3 が表示されます。
パラメータ
src String 定数値設定ファイル名称(拡張子なし)
返却値
void