表 65 に、AgentMetaData クラスのメンバー変数について要約します。
表 65. AgentMetaData クラスのメンバー変数
メンバー変数 | 説明 | ページ |
---|---|---|
agentVersion | ODA のバージョンを指定します。 | allDefaultValues |
searchableNodes | ツリー・ノード内の展開可能なノードの子を、ユーザー指定のパターンで検索できるかどうかを決定します。 | allDependencies |
searchPatternDesc | 有効な検索パターンの基準を説明するためにユーザーに対して表示する説明を指定します。 | allValidValues |
supportedContent | ODA が (サポートするコンテンツ・タイプごとに) サポートするコンテンツ・プロトコルの説明が格納されます。 | allValues |
タイプ
public String agentVersion
注記
agentVersion メンバー変数は、AgentMetaData() コンストラクターの 2 番目の形式の構文により初期化できます。agentVersion は、初期化しない場合、空ストリングになります。どの ODA の場合も、ODA のメタデータを初期化する getMetaData() メソッドの中で、ODA のバージョンを初期化する必要があります。
ツリー・ノード内の展開可能なノードの子を、ユーザー指定の検索パターンで検索できるかどうかを示します。
タイプ
public boolean searchableNodes
注記
searchableNodes メンバー変数には、ユーザーがビジネス・オブジェクト・ウィザードの「ソースの選択」ダイアログ・ボックスでツリー・ノード内の展開可能なノードの子を検索できるかどうかを決定する Boolean 値が格納されます。
ビジネス・オブジェクト・ウィザードは、getTreeNodes() メソッドを呼び出し、ユーザー指定の検索パターンを渡して、親ノード内を検索します。getTreeNodes() メソッドは、名前がこの検索パターンに一致する子をデータ・ソース内で検索し、実際に一致した子のみを戻します。ビジネス・オブジェクト・ウィザードは、親ノードが展開されると、これらの子をユーザーに対して表示します。
AgentMetaData() コンストラクターは、searchableNodes メンバー変数を初期化しません。searchableNodes は、初期化しない場合、値が false になります。ODA で検索パターン機能をサポートする場合は、ODA のクラスに含まれる getMetaData() メソッドの中で、searchableNodes メンバー変数を初期化する必要があります。詳しくは、検索パターン機能の実装を参照してください。
ユーザーに対して表示する、有効な検索パターンの基準を示す説明を指定します。
タイプ
public String searchPatternDesc
注記
searchPatternDesc メンバー変数には、検索パターンについての説明が格納されます。この説明は、「検索パターンの入力」ダイアログ・ボックスに表示されます。ユーザーがソース・ノードを右クリックして「項目を検索」をクリックすると、ビジネス・オブジェクト・ウィザードはこのダイアログ・ボックスを表示します。この説明は、ユーザーが検索基準を指定するときに配慮する必要があるセマンティクスについての情報を提供します。つまり、ODA に実装されている検索の条件を示します。このメンバー変数には、searchableNodes メンバー変数が true の場合に限り、有効な値が格納されます。ODA で検索パターン機能をサポートする場合は、ODA のクラスに含まれる getMetaData() メソッドの中で、searchPatternDesc メンバー変数を初期化する必要があります。詳しくは、検索パターン機能の実装を参照してください。
ODA が (サポートするコンテンツ・タイプごとに) サポートするコンテンツ・プロトコルを示す Vector が格納されます。
タイプ
public Vector supportedContent
注記
supportedContent メンバー変数には、ODA がサポートする生成コンテンツを説明する ContentProtocol オブジェクトで構成された、Java の java.util.Vector が格納されます。各 ContentProtocol オブジェクトに格納される情報は次のとおりです。
コンテンツ生成情報 | 説明 |
---|---|
コンテンツ・タイプ |
サポートされるコンテンツ・タイプを示す、ContentType オブジェクト。次のいずれかです。
|
コンテンツ・プロトコル |
指定されたコンテンツ・タイプ向けにサポートされているコンテンツ・プロトコルを示す、コンテンツ・プロトコル定数のマスク。次のいずれかです。
コンテンツ・プロトコル定数は、ODKConstant インターフェースに定義されています。
|
AgentMetaData() コンストラクターは、引き数として受け取った ODA オブジェクトに対して照会を行って、supportedContent メンバー変数を初期化します。このメンバー変数は、明示的に初期化する必要がありません。