Performs the action for the active
verb of a business object. This method is the primary public interface
for the
business object handler.
Syntax
public int doVerbFor(BusinessObjectInterface theBusObj,
ReturnStatusDescriptor rtnObj);
Parameters
- theBusObj
- Is the incoming business object.
- rtnObj
- Is the status descriptor object that contains an error or informational
message for the integration broker and the status of the operation.
Return values
An integer that indicates the outcome status of the verb operation:
-
CxStatusConstants.SUCCEED
- The verb operation succeeded.
-
CxStatusConstants.FAIL
- The verb operation failed.
-
CxStatusConstants.APPRESPONSETIMEOUT
- The application is not responding.
-
CxStatusConstants.VALCHANGE
- At least one value in the business object changed.
-
CxStatusConstants.VALDUPES
- The requested operation found multiple records for the same key
value.
-
CxStatusConstants.MULTIPLE_HITS
- The connector finds multiple matching records when retrieving using
non-key values. The connector will only return the first matching
record in a business object.
-
CxStatusConstants.RETRIEVEBYCONTENT_FAILED
- The connector was not able to find matches for Retrieve by non-key
values.
-
CxStatusConstants.BO_DOES_NOT_EXIST
- The requested business object entity does not exist in the
database.
Notes
When a business object arrives from the integration broker, the connector
framework creates a status descriptor object and sends it as an argument in
its call to the doVerbFor() method, which performs the action of
the business object's active verb.
- Important:
- The doVerbFor() method is an abstract method that you
must implement for the business object handler.
The doVerbFor() method should take the following steps:
- Perform the verb operation.
- Call
ReturnStatusDescriptor.setErrorString() to set a message in
the status descriptor object if there is an
informational, warning, or
error return message.
- Call
ReturnStatusDescriptor.setStatus() to return a status return
code. The setStatus() method takes an integer whose value
should be the same as the return value of the doVerbFor()
method.
See also
See also the description of the BusinessObjectInterface class.
