Member variables

Table 67 summarizes the member variables of the AgentMetaData class.

Table 67. Member variables of the AgentMetaData class.

Member variable Description Page
agentVersion Specifies the version for the ODA. allDefaultValues
searchableNodes Determines whether the children of the expandable nodes (in the tree node) can be searched by a user-specified pattern. allDependencies
searchPatternDesc Specifies the description to display to users to explain valid search pattern criteria. allValidValues
supportedContent Stores a description of the content protocol that the ODA supports for each of its supported content types. allValues

agentVersion

Specifies the version for the ODA.

Type

public String agentVersion

Notes

The second form of the AgentMetaData() constructor can initialize the agentVersion member variable. If you do not initialize agentVersion, it defaults to an empty string. An ODA should initialize its ODA version as part of the getMetaData() method, which initializes the ODA's metadata.

searchableNodes

Indicates whether the children of the expandable nodes (in a tree node) can be searched by a user-specified search pattern.

Type

public boolean searchableNodes

Notes

The searchableNodes member variable contains a boolean value that determines whether the user is allowed to search the children of an expandable node in the tree node (in the Select Source dialog box of Business Object Wizard):

The AgentMetaData() constructor does not initialize the searchableNodes member variable. If you do not initialize searchableNodes, it defaults to a value of false. If the ODA supports the search-pattern feature, it should initialize the searchableNodes member variable as part of the getMetaData() method in the ODA class. For more information, see Implementing the search-pattern feature.

searchPatternDesc

Specifies the description to display to users that explains the valid search pattern criteria.

Type

public String searchPatternDesc

Notes

The searchPatternDesc member variable stores the search-pattern description, which displays on the Enter a Search Pattern dialog box. Business Object Wizard displays this dialog box when the user right-clicks a source node and clicks Search for items. This description provides information about semantics that the user should use to specify search criteria; that is, it describes what search criteria the ODA implements. This member variable contains a valid value only when the searchableNodes member variable is true. If the ODA supports the search-pattern feature, it should initialize the searchPatternDesc member variable as part of the getMetaData() method in the ODA class. For more information, see Implementing the search-pattern feature.

supportedContent

Contains a vector that describes which content protocol the ODA supports for each of its supported content types.

Type

public Vector supportedContent

Notes

The supportedContent member variable stores a Java java.util.Vector of ContentProtocol objects that describe what generated content the ODA supports. Each ContentProtocol object contains the following information:

Content-generation information Description
Content type

A ContentType object, which lists one of the supported content types:

  • BusinessObject
  • BinaryFile

Content protocol

A mask of the content-protocol constants to indicate the content protocols supported for the specified content type:

  • CONTENT_PROTOCOL_ONREQUEST
  • CONTENT_PROTOCOL_CALLBACK

Content-protocol constants are defined in the ODKConstant interface.

Note:
The ContentProtocol class is part of the ODAInfrastructure package, which contains the classes that the ODA runtime and Business Object Wizard use. This package is not surfaced to ODA developers. All access to ContentProtocol objects is handled by the ODA runtime or Business Object Wizard. An ODA does not access objects of this class directly.

The AgentMetaData() constructor initializes the supportedContent member variable by querying the ODA object that it receives as an argument. You do not have to explicitly initialize this member variable.

Copyright IBM Corp. 1997, 2004