メンバー変数

表 68 に、AgentProperty クラスのメンバー変数について要約します。

表 68. AgentProperty クラスのメンバー変数
メンバー変数 説明 ページ
allDefaultValues エージェント・プロパティーに表示されるデフォルト値を指定します。 allDefaultValues
allDependencies 現在のエージェント・プロパティーとその他の従属プロパティーの間の依存関係を規定する条件を指定します。 allDependencies
allValidValues エージェント・プロパティーの有効値として表示する値を指定します。 allValidValues
allValues エージェント・プロパティーとしてユーザーが選択した値を格納します。 allValues
cardinality エージェント・プロパティーに単一値または複数値の保持を許可するかどうかを指定します。 cardinality
description エージェント・プロパティーのテキスト形式の説明文を入力します。また、その他の関連情報の保持も可能です。 description
isHidden エージェント・プロパティーの値を暗号化して表示する必要があるかどうかを指定します。 isHidden
isMultiple ユーザーが複数の値をエージェント・プロパティーの値として入力できる手段をビジネス・オブジェクト・ウィザードに用意するかどうかを決定します。 isMultiple
isReadOnly ユーザーがエージェント・プロパティーの値を指定できるか、またはプロパティーの値の表示のみ行うことができるかを決定します。 isReadOnly
isRequired エージェント・プロパティーに必ず値が指定されている必要があるかどうかを決定します。 isRequired
propName エージェント・プロパティーの名前を指定します。 propName
type エージェント・プロパティーのデータ型を指定します。 type

allDefaultValues

エージェント・プロパティーに表示されるデフォルト値を指定します。

タイプ

public java.lang.Object[] allDefaultValues
 

注記

allDefaultValues メンバー変数には、エージェント・プロパティーのデフォルト値の配列が格納されます。この配列の Object 要素の数は、次のように、そのプロパティーのカーディナリティー数に一致していなければなりません。

詳しくは、デフォルト値の指定を参照してください。

allDependencies

現在のエージェント・プロパティーとその他の従属プロパティーの間の依存関係を規定する条件のリストを指定します。

タイプ

public CompleteCondition[] allDependencies
 

注記

allDependencies メンバー変数には、CompleteCondition オブジェクトの配列である条件配列に含まれる条件のリストが格納されます。各 CompleteCondition オブジェクトには、エージェント・プロパティーの値に関する条件が 1 つ格納されています。各条件は、入力条件と従属条件で構成されています。詳しくは、プロパティー値に対する条件の設定を参照してください。

allValidValues

エージェント・プロパティーの有効値として表示する値を指定します。

タイプ

public java.lang.Object[] allValidValues
 

注記

allValidValues メンバー変数には、エージェント・プロパティーのドロップダウン・リストの初期設定に使用される値のリストが格納されます。ユーザーは、このドロップダウン・リストから、1 つ (単一カーディナリティーの場合)、または複数 (複数カーディナリティーの場合) の値をプロパティーの値として選択することができます。

allValidValues に値のリストが指定されている場合、ビジネス・オブジェクト・ウィザードは、isMultiple メンバー変数が true であるエージェント・プロパティーのすべてにおいて、それらの値をドロップダウン・リストに表示します。isHiddentrueallValidValues が null の場合、ビジネス・オブジェクト・ウィザードは、ユーザーが値を指定するサブグリッドを表示します。

注:
isMultiple メンバー変数が false の場合、allValidValues メンバー変数は null でなければなりません。

詳しくは、表示コントロールのタイプの選択を参照してください。

allValues

エージェント・プロパティーの値としてユーザーが指定した値が格納されます。

タイプ

public java.lang.Object[] allValues
 

注記

allValues メンバー変数は出力変数です。つまり、ユーザーの入力が完了した、ビジネス・オブジェクト・ウィザードによって値が格納されます。この変数には、ビジネス・オブジェクト・ウィザードの「エージェントの構成」のステップでユーザーが「値」列から選択した値が格納されます。この変数は、エージェント・プロパティーがユーザーに対して表示される前に初期化しておく必要がない 唯一の メンバー変数です。

allValues 配列内の値の数は、エージェント・プロパティーのカーディナリティーによって決まります。

cardinality

エージェント・プロパティーに単一値または複数値の保持を許可するかどうかを指定します。

タイプ

public java.lang.String cardinality
 

注記

cardinality メンバー変数は、エージェント・プロパティーの値が 1 つの値で構成されるか複数の値で構成されるかをを決定します。

したがって、この変数は、ユーザーが特定のエージェント・プロパティーの値として指定できる値の数を決定します。
カーディナリティー ユーザーが指定できるエージェント・プロパティー値の数 cardinality メンバー変数の値
単一 1 つ ODKConstant.SINGLE_CARD
複数 複数 ODKConstant.MULTIPLE_CARD

ビジネス・オブジェクト・ウィザードに表示されるプロパティー用のコントロールのタイプは、そのプロパティーのカーディナリティーによって異なります。詳しくは、表示コントロールのタイプの選択を参照してください。

次の例では、AgentProperty() コンストラクターの 3 番目の形式の構文を呼び出し、6 番目の引き数にカーディナリティーを表すストリング値を指定して、エージェント・プロパティーのカーディナリティーを初期化しています。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, false,
          ODKConstant.SINGLE_CARD, null, null);
 

注:
エージェント・プロパティーのカーディナリティーを決定する値は、AgentProperty() コンストラクターの 2 番目の形式の構文でも、8 番目の引き数を使用して指定することができます。

description

エージェント・プロパティーのテキスト形式の説明文を入力します。また、その他の関連情報の保持も可能です。

タイプ

public java.lang.String description;
 

注記

description メンバー変数に格納されている内容は、ビジネス・オブジェクト・ウィザードの「エージェントの構成」のステップで、「説明」列に表示されます。次の例では、AgentProperty() コンストラクターの 3 番目の形式の構文を呼び出し、3 番目の引き数に説明を表すストリング値を指定して、エージェント・プロパティーの説明を初期化しています。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, false,
          ODKConstant.SINGLE_CARD, null, null);
 

注:
エージェント・プロパティーの説明となる値は、AgentProperty() コンストラクターの 2 番目の形式の構文でも、6 番目の引き数を使用して指定することができます。

isHidden

エージェント・プロパティーの値を暗号化して表示する必要があるかどうかを指定します。

タイプ

public boolean isHidden;
 

注記

isHidden メンバー変数は、ビジネス・オブジェクト・ウィザードにエージェント・プロパティーの値をそのまま表示するかどうかを決定する Boolean 値です。isHidden が true の場合、エージェント・プロパティーの値は、表示されるときに暗号化されます。つまり、値はアスタリスク文字 (*) のストリングとして表示されます。エージェント・プロパティーの値を暗号化するかどうかを指定するには、次のように、AgentProperty() コンストラクターの 2 番目の形式の構文の、4 番目の引き数に Boolean 値を指定します。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING, true, false, true,
          "User Id for logging into the database", true,
          ODKConstant.SINGLE_CARD, null, null);
 

isMultiple

複数の値をエージェント・プロパティーの値として指定できる手段をビジネス・オブジェクト・ウィザードに用意するかどうかを決定します。

タイプ

public boolean isMultiple;
 

注記

isMultiple メンバー変数は、ユーザーが複数の値をエージェント・プロパティーの値として入力できる手段をビジネス・オブジェクト・ウィザードに用意する必要があるかどうかを決定する Boolean 値です。

注:
詳しくは、表示コントロールのタイプの選択を参照してください。

次の例では、AgentProperty() コンストラクターの 3 番目の形式の構文を呼び出し、5 番目の引き数 (isMultiple 変数の値) に Boolean 値 true を指定することにより、エージェント・プロパティーを複数の値から成るリストで初期化して、ユーザーにその中から値を選択させることができるようにしています。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, true,
          ODKConstant.SINGLE_CARD, null, null);
 

注:
isMultiple の値は、AgentProperty() コンストラクターの 2 番目の形式の構文でも、7 番目の引き数を使用して指定することができます。

isReadOnly

ユーザーがエージェント・プロパティーの値を指定できるか、または値の表示のみ行うことができるかを決定します。

タイプ

public boolean isReadOnly;
 

注記

isReadOnly メンバー変数は、ビジネス・オブジェクト・ウィザードにエージェント・プロパティーが表示されるときに、ユーザーがそのプロパティーの値を変更できるかどうかを決定する Boolean 値です。エージェント・プロパティーの値を変更可能にするかどうかを指定するには、次のように、AgentProperty() コンストラクターの 2 番目の形式の構文の、5 番目の引き数に Boolean 値を指定します。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING, true, false, true,
          "User Id for logging into the database", true,
          ODKConstant.SINGLE_CARD, null, null);
 

isRequired

エージェント・プロパティーに値が必要であるかどうかを決定します。

タイプ

public boolean isRequired;
 

注記

isRequired メンバー変数は、エージェント・プロパティーに必ず値を指定する必要があるか、あるいはユーザーがそのプロパティーの値を空のままにできるかを決定する Boolean 値です。isRequiredtrue の場合、ユーザーはそのプロパティーの値を指定しなければなりません。次の例では、AgentProperty() コンストラクターの 3 番目の形式の構文を呼び出し、4 番目の引き数に Boolean 値 true を指定することにより、エージェント・プロパティーに値が必要であることを示しています。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, false,
          ODKConstant.SINGLE_CARD, null, null);
 

注:
isRequired の値は、AgentProperty() コンストラクターの 2 番目の形式の構文でも、3 番目の引き数を使用して指定することができます。

propName

エージェント・プロパティーの名前を指定します。

タイプ

public java.lang.String propName;
 

注記

propName メンバー変数には、エージェント・プロパティーの名前 (Username、Password、DatabaseUrl など) を含むストリングが格納されます。propName メンバー変数の値は、ビジネス・オブジェクト・ウィザードの「エージェントの構成」のステップで、「プロパティー」列に表示されます。次の例では、AgentProperty() コンストラクターの 3 番目の形式の構文を呼び出し、最初の引き数に名前を指定して、エージェント・プロパティーの名前を初期化しています。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, false,
          ODKConstant.SINGLE_CARD, null, null);
 

注:
AgentProperty() コンストラクターのどの構文形式でも、プロパティー名を指定して propName メンバー変数を初期化する必要があります。

type

エージェント・プロパティーのタイプを指定します。

タイプ

public int type;
 

注記

type メンバー変数には、エージェント・プロパティーのデータ型を表す整数値が格納されます。表 67 に、有効なプロパティー・タイプを表すために使用されるプロパティー・タイプ定数を示します。type メンバー変数の値のストリング表現は、ビジネス・オブジェクト・ウィザードの「エージェントの構成」のステップで、「タイプ」列に表示されます。エージェント・プロパティーのデータ型を初期化するには、次のように、AgentProperty() コンストラクターの 2 番目の引き数にプロパティー・タイプ定数を指定します。

AgentProperty agt = new AgentProperty("Username",
          AgentProperty.TYPE_STRING,
          "User Id for logging into the database", true, false,
          ODKConstant.SINGLE_CARD, null, null);
 

Copyright IBM Corp. 2004