getBOSpecificProps()

Sends the specified business-object properties to the BO Properties dialog for user input.

Syntax

public Hashtable getBOSpecificProps(AgentProperty[] properties, 
   String titleBarText);
public Hashtable getBOSpecificProps(AgentProperty[] properties, 
   String titleBarText, String propGridText);

Parameters

properties
Is an array of business-object properties, each property in an AgentProperty object.

titleBarText
Is text to display in the title bar of the BO Properties dialog.

propGridText
Is text to display in a text area above the property grid of the BO Properties dialog.

Return values

A Java Hashtable object of business-object properties (as AgentProperty objects) keyed on the property name.

Exceptions

ODKInvalidPropException
Thrown if the property is invalid--for example, if it does not have a name.

XMLException
Thrown if the XML conversion of the properties failed.

Notes

The getBOSpecificProps() method sends the properties array of business-object properties to Business Object Wizard, who displays them in the BO Properties dialog. From this dialog, the user can enter or change these property values. Before calling the getBOSpecificProps() method, you must instantiate and initialize agent-property (AgentProperty) objects for each business-object property and store each property in the properties business-object-property array. The getBOSpecificProps() method passes this business-object-property array to its caller, Business Object Wizard.

Once the user has set the business-object properties from the BO Properties dialog, Business Object Wizard saves these user-specified properties in a java.util.Hashtable object and the ODA-runtime memory. Within the ODA, you can obtain the user-initialized properties in either of the following ways:

For more information on how to use getBOSpecificProps(), see Requesting business-object properties.

See also

getAllBOSpecificProperties(), getBOSpecificProperty()

Copyright IBM Corp. 1997, 2003