executeCollaboration()

Sends a business object request to the connector framework, which sends it to a business process within the integration broker. This is a synchronous request.

Syntax

void executeCollaboration (char * busProcName, BusinessObject & busObj,
   ReturnStatusDescriptor & rtnStatusDesc);

Parameters

busProcName[in]
Specifies the name of the business process to execute the business object request. If InterChange Server is your integration broker, the business-process name is the name of a collaboration.Use the getCollabNames() method to determine the names of collaborations that are available to process business object requests.

busObj[in/out]
Is the triggering event and the business object returned from the business process.

retStatusDesc[out]
Is the return-status descriptor containing a message and status from the business process.

Return values

None.

Notes

The executeCollaboration() method sends the busObj business object to the connector framework. The connector framework does some processing on the event object to serialize the data and ensure that it is persisted properly. It then sends the event to the busProcName business process in the integration broker. This method initiates a synchronous execution of an event, which means that the method waits for a response from the integration broker's business process.

WebSphere InterChange Server

If your integration broker is IBM WebSphere InterChange Server, the business process that executeCollaboration() invokes is a collaboration.

To receive status information about the business-process execution, pass in an instantiated return-status descriptor, rtnStatusDesc, as the last argument to the method. The integration broker can return status information from its business process and send it to the connector framework, which populates this return-status descriptor with it. You can use the methods of the ReturnStatusDescriptor class to access this status information.

Note:
To initiate an asynchronous execution of an event, use the gotApplEvent() method. Asynchronous execution means that the calling code does not wait for the receipt of the event, nor does it wait for a response.

See also

See also the descriptions of the BusinessObject and ReturnStatusDescriptor classes.

Copyright IBM Corp. 1997, 2004