Qorus Integration Engine®  4.0.3.p1_git
QorusInterfaceTest::FindOrderByKey Class Reference

Finds a workflow order using a key and value. Fails the test if there is more or less than 1 order. More...

Inheritance diagram for QorusInterfaceTest::FindOrderByKey:
QorusInterfaceTest::Action

Public Member Methods

 constructor (string workflowName, string workflowVersion, string keyName, softstring value)
 Creates the action with given parameters. More...
 
FindOrderByKey on (QorusSystemRestHelper restHelper)
 Changes the REST helper to be used to find the workflow order. More...
 
FindOrderByKey on (string connectionName)
 Changes the REST helper to be used to find the workflow order. More...
 
 run (QorusInterfaceTest test)
 Executes the action by calling info.getOrderInfoFromKey() More...
 
*softint getInstanceId ()
 Returns the workflow instance id. More...
 
*hash< auto > getStaticData ()
 Returns static data. More...
 
- Public Member Methods inherited from QorusInterfaceTest::Action
 constructor ()
 creates the object
 

Detailed Description

Finds a workflow order using a key and value. Fails the test if there is more or less than 1 order.

Example:
FindOrderByKey order = exec(new FindOrderByKey("wf name", "1.0", "my_key", "value"));
# use order.getStaticData(), order.getInstanceId() etc.
For finding orders on a remote Qorus instance:
FindOrderByKey order = exec(new FindOrderByKey("wf name", "1.0", "my_key", "value").on("qorus connection name"));
# use order.getStaticData(), order.getInstanceId() etc.

Member Function Documentation

◆ constructor()

QorusInterfaceTest::FindOrderByKey::constructor ( string  workflowName,
string  workflowVersion,
string  keyName,
softstring  value 
)

Creates the action with given parameters.

Parameters
workflowNamethe name of the workflow
workflowVersionthe version of the workflow
keyNamethe name of the key
valuethe value of the key to find

◆ getInstanceId()

*softint QorusInterfaceTest::FindOrderByKey::getInstanceId ( )

Returns the workflow instance id.

Returns
the workflow instance id, if any was found, otherwise NOTHING

◆ getStaticData()

*hash<auto> QorusInterfaceTest::FindOrderByKey::getStaticData ( )

Returns static data.

Returns
the static data, if any was found, otherwise NOTHING

◆ on() [1/2]

FindOrderByKey QorusInterfaceTest::FindOrderByKey::on ( QorusSystemRestHelper  restHelper)

Changes the REST helper to be used to find the workflow order.

Parameters
restHelperthe REST helper to use
Returns
self for chaining

◆ on() [2/2]

FindOrderByKey QorusInterfaceTest::FindOrderByKey::on ( string  connectionName)

Changes the REST helper to be used to find the workflow order.

Parameters
connectionNamethe name of a remote Qorus connection
Returns
self for chaining

◆ run()

QorusInterfaceTest::FindOrderByKey::run ( QorusInterfaceTest  test)
virtual

Executes the action by calling info.getOrderInfoFromKey()

Parameters
testthe QorusInterfaceTest executing this action

Implements QorusInterfaceTest::Action.


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