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 |
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.
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):
Business Object Wizard calls the getTreeNodes() method to search the parent node, passing in the user-specified search pattern. The getTreeNodes() method searches the data source for children whose names match this search pattern, returning only those that do match. Business Object Wizard displays these children to the user when it displays the expanded parent node.
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.
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.
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:
|
Content protocol |
A mask of the content-protocol constants to indicate the content protocols supported for the specified content type:
Content-protocol constants are defined in the ODKConstant
interface.
|
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.