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

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

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

Public Member Methods

abstract public softlist< auto > array ()
 The array method returns the list of elements for the step. More...
 
abstract public nothing primary (auto array_arg)
 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 array 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: MyEventArrayStepClass
# version: 1.0
# desc: my event array step class
class MyEventArrayStepClass inherits QorusEventArrayStep {
softlist<auto> array() {
# .. array logic
}
primary(auto array_arg) {
# .. 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 and Array Step

Member Function Documentation

◆ array()

abstract public softlist<auto> OMQ::UserApi::Workflow::QorusEventArrayStep::array ( )
pure virtual

The array method returns the list of elements for the step.

Returns
The return value of the array function will determine how many times the step will execute, and on what data; null or a zero-length array means to skip the step entirely. Each element in this array indicates an array step element; each element will be passed as the argument to primary() and validation()
Note
this method must always return the same list in the same order in every call (for example if the step must be recovereed); use Workflow Dynamic Order Data to save the list to ensure that this method always returns the same list in the same order if necessary

◆ primary()

abstract public nothing OMQ::UserApi::Workflow::QorusEventArrayStep::primary ( auto  array_arg)
pure virtual

The primary step logic for the event step.

Parameters
array_argthe array element for this step index as returned by the array method

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: