com.ibm.bpe.api

Interface EventHandlerTemplateData

All Superinterfaces:
java.io.Serializable

  1. public interface EventHandlerTemplateData
  2. extends java.io.Serializable
Accesses the properties of an event (action) that can be triggered as part of an active event handler.

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.

  1. 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.
  2. Events can be alarms, that go off after user-set times. Alarms are not described by this data object since they are handled automatically.
When the message constituting an event arrives, the activity specified in the corresponding event handler is carried out. The event, however, remains enabled, even for concurrent use.

Since:
6.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT
  1. static
  2. int
KIND_ON_ALARM
The event handler is signaled after a specific duration of time (timeout event) or at a specific point in time.
  1. static
  2. 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.
  1. static
  2. int
KIND_ON_MESSAGE
The event handler waits for a message to arrive.

Method Summary

Modifier and Type Method and Description
  1. int[]
getAvailableActions()
Returns the actions that can be called for the current event handler.
  1. EHTID
getID()
Returns the object identifier.
  1. java.lang.String
getInputMessageTypeName()
Returns the name of the input message type.
  1. int
getKind()
Returns the kind of the event that is waited for.
  1. java.lang.String
getOperationName()
Returns the name of the operation.
  1. java.lang.String
getPortTypeName()
Returns the name of the partner's port type.
  1. java.lang.String
getPortTypeNamespace()
Returns the namespace of the operation.
  1. PTID
getProcessTemplateID()
Returns the object ID of the process template that contains the event handler.
  1. java.lang.String
getProcessTemplateName()
Returns the name of the process template that contains the event handler.
  1. boolean
isTwoWayOperation()
Returns whether the service to be called is a two-way operation or not.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

KIND_ON_MESSAGE

  1. static final int KIND_ON_MESSAGE
The event handler waits for a message to arrive.
See Also:

KIND_ON_ALARM_REPEATING

  1. 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

  1. 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

  1. EHTID getID()
Returns the object identifier.

getAvailableActions

  1. int[] getAvailableActions()
Returns the actions that can be called for the current event handler. Refer to EventHandlerTemplateActions for the set of possible actions.

getKind

  1. 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

  1. boolean isTwoWayOperation()
Returns whether the service to be called is a two-way operation or not.

getPortTypeNamespace

  1. java.lang.String getPortTypeNamespace( )
Returns the namespace of the operation.

getPortTypeName

  1. java.lang.String getPortTypeName( )
Returns the name of the partner's port type.

getOperationName

  1. java.lang.String getOperationName( )
Returns the name of the operation.

getProcessTemplateID

  1. PTID getProcessTemplateID()
Returns the object ID of the process template that contains the event handler.

getInputMessageTypeName

  1. java.lang.String getInputMessageTypeName( )
Returns the name of the input message type.

getProcessTemplateName

  1. java.lang.String getProcessTemplateName( )
Returns the name of the process template that contains the event handler.