メンバー変数

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

表 65. AgentMetaData クラスのメンバー変数
メンバー変数 説明 ページ
agentVersion ODA のバージョンを指定します。 allDefaultValues
searchableNodes ツリー・ノード内の展開可能なノードの子を、ユーザー指定のパターンで検索できるかどうかを決定します。 allDependencies
searchPatternDesc 有効な検索パターンの基準を説明するためにユーザーに対して表示する説明を指定します。 allValidValues
supportedContent ODA が (サポートするコンテンツ・タイプごとに) サポートするコンテンツ・プロトコルの説明が格納されます。 allValues

agentVersion

ODA のバージョンを指定します。

タイプ

public String agentVersion
 

注記

agentVersion メンバー変数は、AgentMetaData() コンストラクターの 2 番目の形式の構文により初期化できます。agentVersion は、初期化しない場合、空ストリングになります。どの ODA の場合も、ODA のメタデータを初期化する getMetaData() メソッドの中で、ODA のバージョンを初期化する必要があります。

searchableNodes

ツリー・ノード内の展開可能なノードの子を、ユーザー指定の検索パターンで検索できるかどうかを示します。

タイプ

public boolean searchableNodes
 

注記

searchableNodes メンバー変数には、ユーザーがビジネス・オブジェクト・ウィザードの「ソースの選択」ダイアログ・ボックスでツリー・ノード内の展開可能なノードの子を検索できるかどうかを決定する Boolean 値が格納されます。

AgentMetaData() コンストラクターは、searchableNodes メンバー変数を初期化しませんsearchableNodes は、初期化しない場合、値が false になります。ODA で検索パターン機能をサポートする場合は、ODA のクラスに含まれる getMetaData() メソッドの中で、searchableNodes メンバー変数を初期化する必要があります。詳しくは、検索パターン機能の実装を参照してください。

searchPatternDesc

ユーザーに対して表示する、有効な検索パターンの基準を示す説明を指定します。

タイプ

public String searchPatternDesc
 

注記

searchPatternDesc メンバー変数には、検索パターンについての説明が格納されます。この説明は、「検索パターンの入力」ダイアログ・ボックスに表示されます。ユーザーがソース・ノードを右クリックして「項目を検索」をクリックすると、ビジネス・オブジェクト・ウィザードはこのダイアログ・ボックスを表示します。この説明は、ユーザーが検索基準を指定するときに配慮する必要があるセマンティクスについての情報を提供します。つまり、ODA に実装されている検索の条件を示します。このメンバー変数には、searchableNodes メンバー変数が true の場合に限り、有効な値が格納されます。ODA で検索パターン機能をサポートする場合は、ODA のクラスに含まれる getMetaData() メソッドの中で、searchPatternDesc メンバー変数を初期化する必要があります。詳しくは、検索パターン機能の実装を参照してください。

supportedContent

ODA が (サポートするコンテンツ・タイプごとに) サポートするコンテンツ・プロトコルを示す Vector が格納されます。

タイプ

public Vector supportedContent
 

注記

supportedContent メンバー変数には、ODA がサポートする生成コンテンツを説明する ContentProtocol オブジェクトで構成された、Java の java.util.Vector が格納されます。各 ContentProtocol オブジェクトに格納される情報は次のとおりです。
コンテンツ生成情報 説明
コンテンツ・タイプ

サポートされるコンテンツ・タイプを示す、ContentType オブジェクト。次のいずれかです。

  • BusinessObject
  • BinaryFile

コンテンツ・プロトコル

指定されたコンテンツ・タイプ向けにサポートされているコンテンツ・プロトコルを示す、コンテンツ・プロトコル定数のマスク。次のいずれかです。

  • CONTENT_PROTOCOL_ONREQUEST
  • CONTENT_PROTOCOL_CALLBACK

コンテンツ・プロトコル定数は、ODKConstant インターフェースに定義されています。

注:
ContentProtocol クラスは、ODA ランタイムとビジネス・オブジェクト・ウィザードが使用するクラスが含まれている ODAInfrastructure パッケージの一部です。このパッケージは、ODA 開発者が直接使用できるものではありませんContentProtocol オブジェクトへのアクセスは、いずれも、ODA ランタイムまたはビジネス・オブジェクト・ウィザードによって処理されます。ODA がこのクラスのオブジェクトに直接アクセスすることはありません

AgentMetaData() コンストラクターは、引き数として受け取った ODA オブジェクトに対して照会を行って、supportedContent メンバー変数を初期化します。このメンバー変数は、明示的に初期化する必要がありません

Copyright IBM Corp. 2004