ODKUtility class

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:

Note:
Use the getODKUtility() method in this class to obtain a handle to the ODKUtility object.

Table 104 summarizes the methods in the ODKUtility class.

Table 104.

Member methods of 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 box 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 box, 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()

Copyright IBM Corp. 1997, 2003