Performing the verb action

The standard verbs that IBM WebSphere business integration system expect connectors to handle are Create, Retrieve, Update, and Delete. IBM recommends that you implement these verbs according to standard behaviors documented in the sections listed in the For More Information column of Table 27. These sections provide information about the standard behavior, implementation notes, and the appropriate outcome-status values.

Table 27 lists the standard verbs that IBM WebSphere business integration system defines. Your doVerbFor() method should implement those verbs appropriate for its application.

Table 27. Verbs implemented by the doVerbFor() method

Verb Description For more information
Create Make a new entity in the application. "Handling the Create verb"
Retrieve Using key values, return a complete business object. "Handling the Retrieve verb"
RetrieveByContent Using non-key values, return a complete business object. "Handling the RetrieveByContent verb"
Update Change the value in one or more fields in the application. "Handling the Update verb"
Delete Remove the entity from the application. This operation must be a true physical delete. "Handling the Delete verb"
Exists Check whether the entity exists in the application. Handling the Exists verb
Custom verbs Perform some application-specific operation. None

Note:
Although the sections listed in the "For more information" column of Table 27 present suggested behavior for verb methods, your connector might need to implement some aspects of verb processing differently to support a particular application. Once the connector framework passes a request business object to your connector's doVerbFor() method, the doVerbFor() method can implement verb processing in any way that is necessary. Your verb processing code is not limited to the suggestions presented in this chapter.

When InterChange Server is the integration broker and you design your own collaborations, you can implement any custom verbs that you need. Your collaborations and connectors are not limited to the standard list of verbs.

This basic verb-processing logic consists of the following steps:

  1. Get the verb from the request business object.

    The doVerbFor() method must first retrieve the active verb from the business object with the getVerb() method. For a C++ connector, getVerb() is defined in the BusinessObject class.

  2. Perform the verb operation.

    In the business object handler, you can design the doVerbFor() method in either of the following ways:

Copyright IBM Corp. 1997, 2004