OMQ::UserApi::Workflow::QorusNormalStep Class Reference

The abstract class for normal steps. More...

Inheritance diagram for OMQ::UserApi::Workflow::QorusNormalStep:

Public Member Methods
abstract nothing	primary ()
	The primary step logic for the normal step.
public string	validation ()
	Validation logic for the step. More...

Detailed Description

The abstract class for normal steps.

Example

# name: MyNormalStepClass
# version: 1.0
# desc: my normal step class

class MyNormalStepClass inherits QorusNormalStep {
    primary() {
        # ... primary step logic
    }

    string validation() {
        # call checkAction() to check in the target DB if the action has completed
        if (checkAction()) {
            return OMQ::StatComplete;
        }

        # call checkPending() to see if we retry or still wait
        return checkPending() ? OMQ::StatAsyncWaiting : OMQ::StatRetry;
    }

    bool checkAction() {
        # ... logic here
    }

    bool checkPending() {
        # ... logic here
    }
}
# END

Note

Qorus step constructors do not take any arguments; see Class-Based Step Constructors and Static Initialization for information about constructors and static class initialization.

See also

Normal Steps

Member Function Documentation

validation()

public string OMQ::UserApi::Workflow::QorusNormalStep::validation

(

)

Validation logic for the step.

This method must be overridden for steps that can only execute once; by default this method will return OMQ::StatRetry, meaning that the primary step logic will be repeated.

Returns

this must be one of the following step status constants:

• StatComplete: do not run the primary step logic; mark the step as "COMPLETE" and continue
• StatError: do not run the primary step logic; mark the step as "ERROR" and stop running any further dependencies of this step
• StatRetry: run the step function again immediately

Note

if any other value than the above is returned, an error is raised and the return value is treated like OMQ::StatError

See also

• Validation Step Function
• Non-Repeatable Steps Must Include Validation

---

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

• QorusNormalStep.qc