表 69 に、AgentProperty クラスのメソッドについて要約します。
表 69. AgentProperty クラスのメンバー・メソッド
エージェント・プロパティー・オブジェクトを作成します。
構文
public AgentProperty(String name);
public AgentProperty(String name, int type, boolean isReqd, boolean isHid,
boolean isRdOnly, String desc, boolean isMult, String cardinality,
Object[] validValues, Object[] defaultValues);
public AgentProperty(String name, int type, String desc, boolean isReqd,
boolean isMult, String cardinality, Object[] validValues,
Object[] defaultValues);
パラメーター
- cardinality
- プロパティーに複数の値を保持できるようにするかどうかを指定します。エージェント・プロパティー・オブジェクトの cardinality メンバー変数は、このパラメーターの値で初期化されます (cardinality)。
- defaultValues
- プロパティーのデフォルト値を指定します。エージェント・プロパティー・オブジェクトの allDefaultValues メンバー変数は、このパラメーターの値で初期化されます (allDefaultValues)。
- desc
- プロパティーの説明を指定します。エージェント・プロパティー・オブジェクトの description メンバー変数は、このパラメーターの値で初期化されます (description)。
- isHid
- プロパティーの値を暗号化する必要があるかどうかを指定します。エージェント・プロパティー・オブジェクトの isHidden メンバー変数は、このパラメーターの値で初期化されます (isHidden)。
- isMult
- プロパティーに複数の値を用意して、ユーザーがその中から値を選択できるようにするかどうかを指定します。エージェント・プロパティー・オブジェクトの isMultiple メンバー変数は、このパラメーターの値で初期化されます (isMultiple)。
- isRdOnly
- ユーザーにプロパティー値の入力を許可するか、または表示のみ許可するかを指定します。エージェント・プロパティー・オブジェクトの isReadOnly メンバー変数は、このパラメーターの値で初期化されます (isReadOnly)。
- isReqd
- プロパティーに値が必要であるかどうかを指定します。エージェント・プロパティー・オブジェクトの isRequired メンバー変数は、このパラメーターの値で初期化されます (isRequired)。
- name
- プロパティーの名前を指定します。エージェント・プロパティー・オブジェクトの propName メンバー変数は、このパラメーターの値で初期化されます (propName)。
- type
- プロパティーのタイプを指定します。エージェント・プロパティー・オブジェクトの type メンバー変数は、このパラメーターの値で初期化されます (type)。
- validValues
- プロパティーの有効値を指定します。エージェント・プロパティー・オブジェクトの allValidValues メンバー変数は、このパラメーターの値で初期化されます (allValidValues)。
戻り値
新規にインスタンス化された AgentProperty オブジェクト。
例外
- IllegalArgumentException
- name パラメーターの値が null の場合、または type パラメーターが有効なプロパティー・タイプ定数 (表 67 を参照) ではない場合にスローされます。
注記
AgentProperty() メソッドの新規エージェント・プロパティー・オブジェクト生成構文について、以下に説明します。
- 最初の構文形式は、新しいエージェント・プロパティー・オブジェクトを定義し、そのオブジェクトのプロパティー名に限り 初期化します。このエージェント・プロパティーのタイプは、String になります。このプロパティーは、ユーザーに対して複数の値を表示しない、単一カーディナリティーのプロパティーになります。
- 2 番目の構文形式は、新しいエージェント・プロパティー・オブジェクトを定義し、そのオブジェクトのすべての メンバー変数を初期化します。プロパティーのメンバー変数に適切な値を指定することにより、プロパティーのメタデータをカスタマイズすることができます。
- 3 番目の構文形式は、新しいエージェント・プロパティー・オブジェクトを定義し、そのオブジェクトのメンバー変数を、isHidden と isReadOnly を除いて すべて初期化します。この場合、isHidden 変数と isReadOnly 変数は false になります。
指定されたプロパティーを現在の AgentProperty オブジェクト内にコピーします。
構文
public void copy(AgentProperty prop);
パラメーター
- prop
- コピーするプロパティーの名前を指定します。
