Qorus Integration Engine®  4.0.3.p2_git
com.qoretechnologies.qorus.workflow.TempDataHelper Class Reference

Java wrapper for the TempDataHelper class in Qorus. More...

Inheritance diagram for com.qoretechnologies.qorus.workflow.TempDataHelper:
com.qoretechnologies.qorus.workflow.WorkflowDataHelper org::qore::jni::QoreObjectWrapper

Public Member Methods

 TempDataHelper (QoreObject obj)
 creates the object as a wrapper for the Qore object
 
 TempDataHelper () throws Throwable
 creates the TempDataHelper object from the Qore class of the same name
 
void replace (HashMap< String, Object > new_data) throws Throwable
 replaces temp data; the data has already been committed to the database when the method returns More...
 
void replace () throws Throwable
 clears temp data; the change has already been committed to the database when the method returns More...
 
void update (HashMap< String, Object > new_data) throws Throwable
 adds data to temp data; the data has already been committed to the database when the method returns More...
 
void deleteKey (String... keys) throws Throwable
 deletes one or more keys from temp data; the changes have already been committed to the database when the method returns More...
 
- Public Member Methods inherited from com.qoretechnologies.qorus.workflow.WorkflowDataHelper
 WorkflowDataHelper (QoreObject obj)
 creates the object as a wrapper for the Qore object
 
HashMap< String, Objectget (String... keys) throws Throwable
 returns the value of multiple keys in the data or the entire data structure depending on the argument More...
 
Object get (String key) throws Throwable
 returns the value of one key in the data or the entire data structure depending on the argument More...
 
HashMap< String, Objectget () throws Throwable
 returns the entire data structure More...
 

Detailed Description

Java wrapper for the TempDataHelper class in Qorus.

This class is a helper class that allows workflow temp 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 temp data can be made normally while this object exists and the write lock is held; the functions are aware of and automatically use the write lock held by this object:

The Qore-language destructor is run at the end of the Java step execution, after the step returns to Qorus.

Member Function Documentation

◆ deleteKey()

void com.qoretechnologies.qorus.workflow.TempDataHelper.deleteKey ( String...  keys) throws Throwable
inline

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

this method is equivalent to WorkflowApi.deleteTempDataKey()

Parameters
keysthe keys to delete
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() [1/2]

void com.qoretechnologies.qorus.workflow.TempDataHelper.replace ( HashMap< String, Object new_data) throws Throwable
inline

replaces temp 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 temp 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

◆ replace() [2/2]

void com.qoretechnologies.qorus.workflow.TempDataHelper.replace ( ) throws Throwable
inline

clears temp data; the change has already been committed to the database when the method returns

Note
  • there is currently no function equivalent to this method for workflow temp data; this method clears all the 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()

void com.qoretechnologies.qorus.workflow.TempDataHelper.update ( HashMap< String, Object new_data) throws Throwable
inline

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

this method is equivalent to WorkflowApi.updateTempData()

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: