The Qore base interface class for event steps.
More...
|
static public | bindEvent (string eventkey) |
| binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) More...
|
|
static public | bindEventUnposted (string eventkey) |
| binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised More...
|
|
static public | skipEvent () |
| skips a workflow synchronization event step More...
|
|
The Qore base interface class for event steps.
- Note
- Qorus step constructors do not take any arguments; see Class-Based Step Constructors and Static Initialization for information about constructors and static class initialization.
- See also
- Workflow Synchronization Event Steps
◆ bindEvent()
static public OMQ::UserApi::Workflow::QorusEventStepBase::bindEvent |
( |
string |
eventkey | ) |
|
|
static |
binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent)
If this method is called twice for the same step, or if called after skipEvent(), then an exception is raised. The event type is defined when the step is defined in the workflow definition (see Event Type Tag (eventtype)); this information does not need to be supplied here; only the event key, and the event will be automatically created (if it does not exist) or found in the queue as defined by its event type.
- Parameters
-
eventkey | the event key to bind the step to; if the event key does not already exist, then it is created in the table WORKFLOW_EVENTS and automatically tagged with its event type. A record for this step is also created in STEP_INSTANCE_EVENTS |
- Exceptions
-
WORKFLOW-EVENT-ERROR | invalid method call (multiple call, etc) |
- See also
-
- Note
- either bindEvent(), bindEventUnposted(), or skipEvent() must be called in a workflow synchronization event step
◆ bindEventUnposted()
static public OMQ::UserApi::Workflow::QorusEventStepBase::bindEventUnposted |
( |
string |
eventkey | ) |
|
|
static |
binds a workflow synchronization event based on the event key to a workflow synchronization event step (type OMQ::ExecEvent) only if the event has not yet been posted; if the event has already been posted, then an ALREADY-POSTED exception is raised
If this method is called twice for the same step, or if called after skipEvent(), then an exception is raised. The event type is defined when the step is defined in the workflow definition (see Event Type Tag (eventtype)); this information does not need to be supplied here; only the event key, and the event will be automatically created (if it does not exist) or found in the queue as defined by its event type.
- Parameters
-
eventkey | the event key to bind the step to; if the event key does not already exist, then it is created in the table WORKFLOW_EVENTS and automatically tagged with its event type. A record for this step is also created in STEP_INSTANCE_EVENTS |
- Exceptions
-
ALREADY-POSTED | the given event has already been posted |
WORKFLOW-EVENT-ERROR | invalid method call (multiple call, etc) |
- See also
-
- Note
- either bindEvent(), bindEventUnposted(), or skipEvent() must be called in a workflow synchronization event step
◆ skipEvent()
static public OMQ::UserApi::Workflow::QorusEventStepBase::skipEvent |
( |
| ) |
|
|
static |
skips a workflow synchronization event step
If this method is called from any other step type, or if called after bindEvent(), then an exception is raised. If called twice for the same step a message is logged, but no exception is raised.
- Exceptions
-
WORKFLOW-EVENT-ERROR | invalid method call (multiple call, etc) |
- See also
-
- Note
- either bindEvent(), bindEventUnposted(), or skipEvent() must be called in a workflow synchronization event step
The documentation for this class was generated from the following file: