public interface ReplyContext
extends java.io.Serializable
callWithReplyContext
methods.
A client that uses these API methods has to create an object that implements the ReplyContext interface so that the process engine knows where to send results to. When a process instance that was started via the callWithReplyContext() API reaches its end, the process engine calls replyProcessResult() or replyException() depending on the result of processing. It is the responsibility of the implementation of this interface to perform the necessary actions in order to inform the caller about the result of processing.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT |
static long |
serialVersionUID |
Modifier and Type | Method and Description |
---|---|
void |
replyException(int processState,
java.lang.String processInstanceName,
java.lang.Exception exception)
Signals the unsuccessful execution of a process.
|
void |
replyProcessResult(int processState,
java.lang.String processInstanceName,
java.lang.Object resultMessage)
Signals the successful end of process execution and returns an output message.
|
static final java.lang.String COPYRIGHT
static final long serialVersionUID
void replyProcessResult(int processState, java.lang.String processInstanceName, java.lang.Object resultMessage) throws SendReplyErrorException
replyException
method.processState
- The final state of the process instance, either finished, failed, terminated, or compensated.processInstanceName
- The name of the process instance.resultMessage
- The output message that represents the result of execution.SendReplyErrorException
- if the process instance result cannot be returned.void replyException(int processState, java.lang.String processInstanceName, java.lang.Exception exception) throws SendReplyErrorException
replyProcessResult
method.processState
- The state of the process instance.processInstanceName
- The name of the process instance.exception
- The exception that terminated processing. Can be any subclass of ProcessException or
ProcessError or one of its subclasses.SendReplyErrorException
- if the exception cannot be returned.