The Object Discovery Agent Development Kit (ODK) API provides the ODKUtility class to provide an Object Discovery Agent (ODA) with various utility methods. By obtaining a handle to the singleton ODKUtility object, the ODA can access the following functionality:
Table 104 summarizes the methods in the ODKUtility
class.
Member method | Description | Page |
---|---|---|
contentComplete() | Notifies Business Object Wizard that the ODA has completed content generation when using the callback protocol. | contentComplete() |
getAgentProperty() | Retrieves the specified ODA configuration property. | getAgentProperty() |
getAllAgentProperties() | Retrieves all ODA configuration properties. | getAllAgentProperties() |
getAllBOSpecificProperties() | Retrieves all business-object properties. | getAllBOSpecificProperties() |
getBOSpecificProperty() | Retrieves the specified business-object property. | getBOSpecificProperty() |
getBOSpecificProps() | Sends the specified business-object properties to the BO Properties dialog for user input. | getBOSpecificProps() |
getClientFile() | Requests that Business Object Wizard retrieve a specified file. | getClientFile() |
getMsg() | Returns a message from the ODA message file. | getMsg() |
getODKUtility() | Returns a handle to an ODKUtility object. | getODKUtility() |
sendMsg() | Displays a user-response dialog,which includes a message and button, and requires a response from the user. | sendMsg() |
sendStatusMsg() | Displays a message to the user. | sendStatusMsg() |
trace() | Writes a message to the trace file. | trace() |