Qorus Integration Engine®  5.1.2_git
OMQ::UserApi::Workflow::QorusEventStep Class Referenceabstract

The abstract class for workflow synchronization event steps. More...

Inheritance diagram for OMQ::UserApi::Workflow::QorusEventStep:
OMQ::UserApi::Workflow::QorusEventStepBase OMQ::UserApi::Workflow::QorusStepBase

Public Member Methods

abstract public nothing primary ()
 The primary step logic for the event step. More...
 

Additional Inherited Members

- Static Public Member Methods inherited from OMQ::UserApi::Workflow::QorusEventStepBase
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...
 

Detailed Description

The abstract class for workflow synchronization event steps.

Workflow synchronization event steps allow many workflow orders to synchronize their processing based on a single event.

Event steps may not have validation logic.

Example
# name: MyEventStepClass
# version: 1.0
# desc: my event array step class
class MyEventStepClass inherits QorusEventStep {
primary() {
# .. primary step logic; must call one of:
# * bindEvent()
# * bindEventUnposted()
# * skipEvent()
}
}
# END
Note
Qorus step constructors do not take any arguments; see Step Constructors and Static Initialization for information about constructors and static class initialization.
See also
Workflow Synchronization Event Steps

Member Function Documentation

◆ primary()

abstract public nothing OMQ::UserApi::Workflow::QorusEventStep::primary ( )
pure virtual

The primary step logic for the event step.

This code must call either bindEvent(), bindEventUnposted(), or skipEvent() or an error will be raised.


The documentation for this class was generated from the following file: