Qorus Integration Engine®  4.0.3.p1_git
OMQ::UserApi::Workflow::QorusStepBase Class Reference

Base class for workflow step classes. More...

Inheritance diagram for OMQ::UserApi::Workflow::QorusStepBase:
OMQ::UserApi::Workflow::QorusAsyncStepBase OMQ::UserApi::Workflow::QorusEventStepBase OMQ::UserApi::Workflow::QorusNormalArrayStep OMQ::UserApi::Workflow::QorusNormalStep OMQ::UserApi::Workflow::QorusSubworkflowStepBase OMQ::UserApi::Workflow::QorusAsyncArrayStep OMQ::UserApi::Workflow::QorusAsyncStep OMQ::UserApi::Workflow::QorusEventArrayStep OMQ::UserApi::Workflow::QorusEventStep OMQ::UserApi::Workflow::QorusSubworkflowArrayStep OMQ::UserApi::Workflow::QorusSubworkflowStep

Private:Internal Member Methods

*hash< auto > getDefaultStepData ()
 Returns the default dynamic step data for the step when the step is first run. More...
 
*hash< auto > getStepMetadata ()
 Returns step user metadata for the step when the step is loaded by oload. More...
 

Static Private:Internal Member Methods

static updateStepData (hash< auto > new_data)
 Updates the values of one or more keys in the workflow order data instance’s dynamic step data hash. More...
 
static deleteStepDataKey (softlist< softstring > keylist)
 Deletes one or more keys from the workflow order data instance’s dynamic step data hash. More...
 
static auto getStepData ()
 Retrieves the values of one or more keys from the workflow order data instance’s dynamic step data hash. More...
 
static auto getStepDataArgs (*softlist< softstring > keylist)
 Retrieves the values of one or more keys from the workflow order data instance’s dynamic step data hash. More...
 

Detailed Description

Base class for workflow step classes.

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.

Member Function Documentation

◆ deleteStepDataKey()

static OMQ::UserApi::Workflow::QorusStepBase::deleteStepDataKey ( softlist< softstring >  keylist)
staticprivate:internal

Deletes one or more keys from the workflow order data instance’s dynamic step data hash.

Dynamic step data is directly linked to the order data the workflow execution instance is processing.

Changes are committed to the database before the method returns.

Parameters
keylista single key or a list of keys to delete in the workflow order's dynamic step data
Note
The use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also
Since
Qorus 4.0.1

◆ getDefaultStepData()

*hash<auto> OMQ::UserApi::Workflow::QorusStepBase::getDefaultStepData ( )
private:internal

Returns the default dynamic step data for the step when the step is first run.

Returns
the default dynamic step data for the step when the step is first run

The default implementation in the base class returns NOTHING

Note
This method is executed at runtime when the step instance is first created
Since
Qorus 4.0.1

◆ getStepData()

static auto OMQ::UserApi::Workflow::QorusStepBase::getStepData ( )
staticprivate:internal

Retrieves the values of one or more keys from the workflow order data instance’s dynamic step data hash.

Dynamic step data is directly linked to the order data the workflow execution instance is processing.

Pass a single string argument, in which case the value of that key is returned, or a list of strings, in which case a hash is returned giving the values of all the keys requested

See also
Since
Qorus 4.0.1

◆ getStepDataArgs()

static auto OMQ::UserApi::Workflow::QorusStepBase::getStepDataArgs ( *softlist< softstring >  keylist)
staticprivate:internal

Retrieves the values of one or more keys from the workflow order data instance’s dynamic step data hash.

Dynamic step data is directly linked to the order data the workflow execution instance is processing.

Parameters
keylistfor a single string argument, the value of that key is returned, for a list of strings, a hash is returned giving the values of all the keys requested
See also
Since
Qorus 4.0.1

◆ getStepMetadata()

*hash<auto> OMQ::UserApi::Workflow::QorusStepBase::getStepMetadata ( )
private:internal

Returns step user metadata for the step when the step is loaded by oload.

Returns
stepusermetadata "step user metadata" for the step when the step is loaded by oload

The default implementation in the base class returns NOTHING

Note
This method is executed by oload when the step is created in the database and therefore this method should not use any runtime functionality.
Since
Qorus 4.0.1

◆ updateStepData()

static OMQ::UserApi::Workflow::QorusStepBase::updateStepData ( hash< auto >  new_data)
staticprivate:internal

Updates the values of one or more keys in the workflow order data instance’s dynamic step data hash.

Dynamic step data is directly linked to the order data the workflow execution instance is processing.

Changes are committed to the database before the method returns.

Parameters
new_datathe key-value pairs to update in dynamic step data
Note
  • This call does not replace the step data hash; any keys in the hash parameter are added to the step data hash
  • The use of this method causes SQL I/O to be performed in the system schema; to maximize performance, calls to this and other similar methods should be minimized if possible
See also
Since
Qorus 4.0.1

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