Skip to end of banner
Go to start of banner

getWorkflowStatusIds

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Availability

This routine is available since katl-commons 3.1.9.

Syntax:

getWorkflowStatusIds(workflowName [, isDraft])

Description:

Retrieves an unique list of statuses (ids) for a given workflow

Parameters: 

Parameter name

Type

Required

Description

workflow name

String

Yes

the name of the given workflow

isDraftBooleanNoflag for specifying whether we should consider the draft or not. If not specified, it defaults to false.

Return type:

string []

The return value is an array of strings, containing the ids for the existing statuses in the workflow.

Example:


string key = "TEST-19";
return getWorkflowStatusIds(key.workflow);

Result:  1|3|4|5|6


Example 2:


string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, false);

Result:  1|3|4|5|6


Example 3:

Setting the second parameter to true, if we do have a draft in which there is another status added, the result will contain this status also.

string key = "TEST-19";
return getWorkflowStatusIds(key.workflow, true);

Result:  1|3|4|5|6|10100


See Also:

  • No labels