This class is a helper class that allows workflow dynamic step data to be read and updated atomically; the write lock for the data is grabbed in the constructor and released in the destructor.
More...
|
| constructor () |
| creates the object and grabs the write lock for workflow dynamic step data during the lifetime of the object More...
|
|
| 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 More...
|
|
nothing | replace (*hash< auto > new_data) |
| replaces dynamic step 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 step data; the data has already been committed to the database when the method returns More...
|
|
nothing | deleteKey (softlist< softstring > keylist) |
| deletes one or more keys from dynamic step data; the changes have already been committed to the database when the method returns More...
|
|
This class is a helper class that allows workflow dynamic step 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 methods related to workflow dynamic step data can be made normally while this object exists and the write lock is held; the nethods are aware of and automatically use the write lock held by this object:
- Since
- Qorus 4.0.1
◆ constructor()
OMQ::UserApi::Workflow::StepDataHelper::constructor |
( |
| ) |
|
|
private:internal |
creates the object and grabs the write lock for workflow dynamic step data during the lifetime of the object
- Exceptions
-
LOCK-ERROR | another StepDataHelper 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::StepDataHelper::deleteKey |
( |
softlist< softstring > |
keylist | ) |
|
|
private:internal |
deletes one or more keys from dynamic step data; the changes have already been committed to the database when the method returns
this method is equivalent to QorusStepBase::deleteStepDataKey()
- 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
◆ get()
auto OMQ::UserApi::Workflow::StepDataHelper::get |
( |
auto |
field | ) |
|
|
private:internal |
returns the value of one or more keys in the data or the entire data structure depending on the argument
this method is equivalent to QorusStepBase::getStepData()
◆ replace()
nothing OMQ::UserApi::Workflow::StepDataHelper::replace |
( |
*hash< auto > |
new_data | ) |
|
|
private:internal |
replaces dynamic step 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 step 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::StepDataHelper::update |
( |
hash< auto > |
new_data | ) |
|
|
private:internal |
adds data to dynamic step data; the data has already been committed to the database when the method returns
this method is equivalent to QorusStepBase::updateStepData()
- 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: