doVerbFor()

Performs the action for the active verb of a business object.

Syntax

virtual int doVerbFor(BusinessObject & theBusObj,
    ReturnStatusDescriptor * rtnStatusDesc);
 

Parameters

theBusObj [in]
Is the business object whose active verb is to be processed.
rtnStatDesc [out]
Is the return-status descriptor object that doVerbFor() should update with an error or informational message to send to the integration broker to indicate the status of the operation.

Return values

An integer that indicates the outcome status of the verb operation. Compare this integer value with the following outcome-status constants to determine the status:

BON_SUCCESS
The verb operation succeeded.
BON_FAIL
The verb operation failed.
BON_APPRESPONSETIMEOUT
The application is not responding.
BON_BO_DOES_NOT_EXIST
The connector performed a Retrieve operation, but the application database does not contain a matching entity for the requested business object
BON_MULTIPLE_HITS
The connector found multiple matching records when retrieving using non-key values. The connector returns a business object only for the first matching record.
BON_FAIL_RETRIEVE_BY_CONTENT
The connector was not able to find matches for Retrieve by non-key values.
BON_VALCHANGE
At least one value in the business object changed.
BON_VALDUPES
The requested operation found multiple records in the application database with the same key values.

Notes

The doVerbFor() method performs the action of the business object's active verb. This method is the primary public interface for the business object handler.

Important:
The doVerbFor() method is a virtual method.Therefore, the connector must implement this method as part of the business object handler.

When a business object arrives from InterChange Server, the connector framework creates a return-status descriptor object and passes it (along with the business object) to the doVerbFor() method. This method performs the verb operation and then calls methods in the ReturnStatusDescriptor class to set the appropriate values in the return-status descriptor, as follows:

seterrMsg() Sets a message in the return-status descriptor object if there is an informational, warning, or error return message.

The connector framework returns this return-status descriptor to the integration broker. It also returns the outcome status, which is the return code of the doVerbFor() method.

See also

seterrMsg()

Copyright IBM Corp. 1997, 2003