Qorus Integration Engine®  4.1.4.p2_git
status Class Reference

the main status service class More...

Inherits QorusSystemService.

Public Member Methods

hash retryAll (softint wfiid)
 DEPRECATED: sets all steps/segments with an ERROR status (segment must not be IN-PROGRESS) to OMQ::StatRetry. More...
 
hash cancelWorkflow (softint wfiid)
 DEPRECATED: sets a workflow order instance with status ERROR, RETRY, ASYNC-WAITING, or WAITING to CANCELED (+ all associated flows & segments) More...
 
hash setError (softint wfiid)
 DEPRECATED: sets a workflow order instance with status RETRY, ASYNC-WAITING, or CANCELED to ERROR (+ all associated segments) More...
 
nothing skipStep (softint wfiid, softint stepid, *softint ind)
 DEPRECATED: flags a step to be skipped. More...
 

Detailed Description

the main status service class

Member Function Documentation

◆ cancelWorkflow()

hash status::cancelWorkflow ( softint  wfiid)
inline

DEPRECATED: sets a workflow order instance with status ERROR, RETRY, ASYNC-WAITING, or WAITING to CANCELED (+ all associated flows & segments)

Parameters
wfiidthe workflow_instanceid to cancel
Deprecated:
use PUT /api/latest/orders/{id}?action=cancel instead

◆ retryAll()

hash status::retryAll ( softint  wfiid)
inline

DEPRECATED: sets all steps/segments with an ERROR status (segment must not be IN-PROGRESS) to OMQ::StatRetry.

Parameters
wfiidthe workflow_instanceid to retry
Deprecated:
use rest_api_PUT_latest_orders__id__retry instead

◆ setError()

hash status::setError ( softint  wfiid)
inline

DEPRECATED: sets a workflow order instance with status RETRY, ASYNC-WAITING, or CANCELED to ERROR (+ all associated segments)

Parameters
wfiidthe workflow_instanceid to set to ERROR
Deprecated:
PUT /api/latest/orders/{id}?action=setError instead

◆ skipStep()

nothing status::skipStep ( softint  wfiid,
softint  stepid,
*softint  ind 
)
inline

DEPRECATED: flags a step to be skipped.

Parameters
wfiidthe workflow_instanceid of the step to skip
stepidthe step ID of the step to skip
indthe step index of the step to skip; if not present, defaults to 0
Note
CAUTION: could cause a workflow to stall if the step retrieves data needed in subsequent steps
Deprecated:
use PUT /api/latest/orders/{id}?action=skipStep instead

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