getAgentProperties()

Sends an array of ODA configuration properties to Business Object Wizard.

Syntax

public abstract AgentProperty[] getAgentProperties();

Parameters

None.

Return values

An array of AgentProperty objects, one object for each ODA configuration property.

Exceptions

ODKException
Thrown if the ODA fails to get the configuration properties.

Notes

Business Object Wizard invokes the getAgentProperties() method to get the array of ODA configuration properties that initializes its Configure Agent (Step 2) dialog box. From this dialog box, you can enter or change these property values.

Important:
The getAgentProperties() method is an abstract method that has no default implementation.Therefore, the ODA class must implement this method.

Within the getAgentProperties() method, you must instantiate and initialize agent-property (AgentProperty) objects for each ODA configuration property and store each property in the configuration-property array. The getAgentProperties() method returns this configuration-property array to its caller, Business Object Wizard. Once the user has set the configuration properties from the Configure Agent dialog box, Business Object Wizard reads these user-initialized properties in the ODA-runtime memory. You can obtain the user-initialized property with either the getAgentProperty() or getAllAgentProperties() method in the ODKUtility class. For more information on how to implement getAgentProperties(), see Obtaining configuration properties.

See also

getAgentProperty(), getAllAgentProperties()

Copyright IBM Corp. 1997, 2004