Qorus Integration Engine®  5.1.2_git
OMQ::UserApi::Workflow::DynamicDataHelper Class Reference

This class is a helper class that allows workflow dynamic data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor. More...

Inheritance diagram for OMQ::UserApi::Workflow::DynamicDataHelper:
OMQ::UserApi::Workflow::WorkflowDataHelper

Private:Internal Member Methods

 constructor ()
 creates the object and grabs the write lock for workflow dynamic data during the lifetime of the object More...
 
nothing replace (*hash< auto > new_data)
 replaces dynamic data; the data has already been committed to the database when the method returns More...
 
nothing update (hash< auto > new_data)
 adds data to dynamic data; the data has already been committed to the database when the method returns More...
 
nothing deleteKey (softlist< softstring > keysv)
 deletes one or more keys from dynamic data; the changes have already been committed to the database when the method returns More...
 

Additional Inherited Members

- Public Member Methods inherited from OMQ::UserApi::Workflow::WorkflowDataHelper
 destructor ()
 destroys the object and releases the write lock
 
auto get (auto field)
 returns the value of one or more keys in the data or the entire data structure depending on the argument
 

Detailed Description

This class is a helper class that allows workflow dynamic data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor.

Calls to the following workflow API functions related to workflow dynamic data can be made normally while this object exists and the write lock is held

Since
Qorus 3.1.0

Member Function Documentation

◆ constructor()

OMQ::UserApi::Workflow::DynamicDataHelper::constructor ( )
private:internal

creates the object and grabs the write lock for workflow dynamic data during the lifetime of the object

Exceptions
LOCK-ERRORanother DynamicDataHelper object exists in the same thread; only one object can be used at a time since the object grabs the write lock

◆ deleteKey()

nothing OMQ::UserApi::Workflow::DynamicDataHelper::deleteKey ( softlist< softstring >  keysv)
private:internal

deletes one or more keys from dynamic data; the changes have already been committed to the database when the method returns

this method is equivalent to WorkflowApi::deleteDynamicDataKey()

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

◆ replace()

nothing OMQ::UserApi::Workflow::DynamicDataHelper::replace ( *hash< auto >  new_data)
private:internal

replaces dynamic data; the data has already been committed to the database when the method returns

Note
  • There is currently no function equivalent to this method for workflow dynamic data; this method replaces all the data with new_data
  • 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

◆ update()

nothing OMQ::UserApi::Workflow::DynamicDataHelper::update ( hash< auto >  new_data)
private:internal

adds data to dynamic data; the data has already been committed to the database when the method returns

this method is equivalent to WorkflowApi::updateDynamicData()

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

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