ReturnStatusDescriptor class

The ReturnStatusDescriptor class enables connectors to return error and informational messages in a return-status descriptor. This descriptor provides additional status information is usually returned as part of the request response sent to the integration broker.

WebSphere InterChange Server

If your business integration system uses InterChange Server, the connector framework returns the return-status descriptor to the collaboration that initiated the request. The collaboration can access the information in this return-status descriptor to obtain the status of its service call request.

The header file for this class is ReturnStatusDescriptor.hpp. It resides in the following subdirectory of your product directory:

DevelopmentKits\cdk\generic_include
 

Table 109 summarizes the methods in the ReturnStatusDescriptor class.

Table 109.

Member methods of the ReturnStatusDescriptor class
Member method Description Page
getErrorMsg() Retrieves an error message string from a return-status descriptor. getErrorMsg()
getStatus() Retrieves the status value from a return-status descriptor. getStatus()
seterrMsg() Sets a string containing an error or informational message in the return-status descriptor. seterrMsg()
setStatus() Sets the status value in the return-status descriptor. setStatus()

Copyright IBM Corp. 1997, 2003