Methods

Table 68 summarizes the methods of the AgentMetaData class.

Table 68. Member methods of the AgentMetaData class

Member method Description Page
AgentMetaData() Creates an agent-metadata object. AgentMetaData()
toXml() Copies the specified property into the current AgentProperty object. toXml()

AgentMetaData()

Creates an agent-metadata object.

Syntax

public AgentMetaData(ODKAgentBase2 ODAobject);
public AgentProperty(ODKAgentBase2 ODAobject, String version);

Parameters

ODAobject
Is a reference to the ODA object that represents the ODA. The constructor queries this object to initialize the supportedContent member variable of the AgentMetaData object (supportedContent).

version
Specifies the version of the ODA; the value of this parameter initializes the agentVersion member variable of the AgentMetaData object (agentVersion).

Return values

A newly instantiated AgentMetaData object.

Notes

The AgentMetaData() method queries the ODAobject ODA for its supported content. This constructor provides the following forms for instantiating a new AgentMetaData object:

Both of these forms of the constructor use the ODAobject reference to query the ODA for its supported content. Using this information, the constructor initialize the supportedContent member variable.

Note:
The AgentMetaData() constructor does not initialize the member variables that support the search-pattern feature. For your ODA to support search patterns, you must explicitly initialize the searchableNodes and searchPatternDesc member variables after the AgentMetaData object is instantiated. If you do not initialize searchableNodes, it defaults to a value of false.

toXml()

Converts the ODA metadata into an XML format.

Syntax

public String toXml();

Parameters

None.

Return values

A String that contains the XML format for the current AgentMetaData object.

Copyright IBM Corp. 1997, 2004