com.ibm.bpe.api
Interface EventHandlerTemplateData
All Superinterfaces:
java.io.Serializable
- public interface EventHandlerTemplateData
- extends java.io.Serializable
BPEL event handlers allow for receiving external events and requests concurrently with the running process instance. This is especially helpful for events and requests that may occur at arbitrary times and an arbitrary number of times.
There are two types of events.
- Events can be incoming messages that correspond to a request/response or one-way operation in WSDL. For instance, a status query is likely to be a request/response operation, whereas a cancellation may be a one-way operation.
- Events can be alarms, that go off after user-set times. Alarms are not described by this data object since they are handled automatically.
Since:
6.0
Field Summary
Modifier and Type | Field and Description |
---|---|
|
COPYRIGHT
|
|
KIND_ON_ALARM
The event handler is signaled after a specific duration of time (timeout event) or at a specific point in time.
|
|
KIND_ON_ALARM_REPEATING
The event handler is signaled after a specific duration of time (timeout event)
or at a specific point in time and the alarm is repeated after defined intervals.
|
|
KIND_ON_MESSAGE
The event handler waits for a message to arrive.
|
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getAvailableActions()
Returns the actions that can be called for the current event handler.
|
getID()
Returns the object identifier.
|
|
|
getInputMessageTypeName()
Returns the name of the input message type.
|
|
getKind()
Returns the kind of the event that is waited for.
|
|
getOperationName()
Returns the name of the operation.
|
|
getPortTypeName()
Returns the name of the partner's port type.
|
|
getPortTypeNamespace()
Returns the namespace of the operation.
|
getProcessTemplateID()
Returns the object ID of the process template that contains the event handler.
|
|
|
getProcessTemplateName()
Returns the name of the process template that contains the event handler.
|
|
isTwoWayOperation()
Returns whether the service to be called is a two-way
operation or not.
|
Field Detail
COPYRIGHT
- static final java.lang.String COPYRIGHT
See Also:
KIND_ON_MESSAGE
- static final int KIND_ON_MESSAGE
The event handler waits for a message to arrive.
See Also:
KIND_ON_ALARM_REPEATING
- static final int KIND_ON_ALARM_REPEATING
The event handler is signaled after a specific duration of time (timeout event)
or at a specific point in time and the alarm is repeated after defined intervals.
See Also:
KIND_ON_ALARM
- static final int KIND_ON_ALARM
The event handler is signaled after a specific duration of time (timeout event) or at a specific point in time.
See Also:
Method Detail
getID
- EHTID getID()
Returns the object identifier.
getAvailableActions
- int[] getAvailableActions()
Returns the actions that can be called for the current event handler.
Refer to
EventHandlerTemplateActions
for the set
of possible actions.
getKind
- int getKind()
Returns the kind of the event that is waited for.
Possible values are: KIND_ON_MESSAGE, KIND_ON_ALARM, KIND_ON_ALARM_REPEATING.
isTwoWayOperation
- boolean isTwoWayOperation()
Returns whether the service to be called is a two-way
operation or not.
getPortTypeNamespace
- java.lang.String getPortTypeNamespace( )
Returns the namespace of the operation.
getPortTypeName
- java.lang.String getPortTypeName( )
Returns the name of the partner's port type.
getOperationName
- java.lang.String getOperationName( )
Returns the name of the operation.
getProcessTemplateID
- PTID getProcessTemplateID()
Returns the object ID of the process template that contains the event handler.
getInputMessageTypeName
- java.lang.String getInputMessageTypeName( )
Returns the name of the input message type.
getProcessTemplateName
- java.lang.String getProcessTemplateName( )
Returns the name of the process template that contains the event handler.