Raise Collaboration Exception

Prepares a collaboration exception to raise it to the next higher level of execution. This function block creates a new exception object with the specified exception type and a message string. Use this form to pass an exception message stored as a string.

Note:
This function block is located in the General\APIs\Collaboration Template\Exception folder.

Inputs

Collaboration
The current collaboration object.

Exception type
A String that specifies the exception type.

messageNum
An integer that specifies the number for the message associated with the exception object.

Notes

The Raise Collaboration Exception function block prepares a collaboration exception to raise to the next higher level of execution. When the collaboration runtime environment executes the Raise Collaboration Exception function block, it changes the collaboration's execution to the Exception state, then proceeds with the logic of the activity diagram. How the activity diagram responds to the raised exception depends on the termination node of its execution path, as follows:

Related information

This function block is based on the BaseCollaboration.sendEmail() method. For more information, see sendEmail().

Copyright IBM Corp. 1997, 2004