doVerbForCustom()

Performs the custom verb processing for the active verb of a business object.

Syntax

public int doVerbForCustom(CWConnectorBusObj theBusObj);
 

Parameters

theBusObj
Is the business object whose active verb is to be processed.

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:

CWConnectorConstant.SUCCEED
The verb operation succeeded.

CWConnectorConstant.FAIL
The verb operation failed.

CWConnectorConstant.APPRESPONSETIMEOUT
The application is not responding.

CWConnectorConstant.VALCHANGE
At least one value in the business object changed.

CWConnectorConstant.VALDUPES
The requested operation found multiple records in the application database for the same key value.

CWConnectorConstant.MULTIPLE_HITS
The connector finds multiple matching records when retrieving using non-key values. The connector returns a business object only for the first matching record.

CWConnectorConstant.RETRIEVEBYCONTENT_FAILED
The connector was not able to find matches for Retrieve by non-key values.

CWConnectorConstant.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.

Exceptions

ConnectionFailureException
Thrown if the connector has lost the connection with the application.

VerbProcessingFailedException
Thrown if the verb processing fails.

Notes

The doVerbForCustom() method performs the action of the active verb in the theBusObj business object, if this business object's verb application-specific information contains the CBOH tag. This tag specifies the entire class name (including its package name) for your implementation of the CWCustomBOHandlerInterface interface. For information on the format of this tag, see Adding the verb application-specific information.

When a business object handler is invoked, the low-level doVerbFor() method, (inherited from the BOHandlerBase class) is what the connector framework actually invokes. The low-level doVerbFor() method determines which business object handler to call as follows:

For more information, see "Populating the return-status descriptor".

If the doVerbForCustom() method needs to throw one of its exceptions, it first needs to populate an exception-detail object that it contain information about the exception. For more information, see Table 117. For information about how to implement this method, see Implementing the doVerbForCustom() method.

See also

doVerbFor()

Copyright IBM Corp. 1997, 2003