Class NSWorkflowStepOptionBase
Carrier object for WorkflowStepOptionBase.
Syntax
Constructors
NSWorkflowStepOptionBase()
Initializes a new instance of the NSWorkflowStepOptionBase class.
Declaration
NSWorkflowStepOptionBaseMethods
GetName()
Gets the name of this option.
Declaration
String GetName()Returns
| Type | Description |
|---|---|
| String | Option name. |
GetOptionType()
Gets the type of option.
Declaration
WorkflowSplitOptionType GetOptionType()Returns
| Type | Description |
|---|---|
| WorkflowSplitOptionType | Option type. |
GetRank()
Gets the step order.
Declaration
Integer GetRank()Returns
| Type | Description |
|---|---|
| Integer | Step order. |
GetSteps()
Gets the steps to execute if this option/path is selected.
Declaration
NSWorkflowStepBase[] GetSteps()Returns
| Type | Description |
|---|---|
| NSWorkflowStepBase[] | Array of workflow steps. |
GetWorkflowId()
Gets the workflow id.
Declaration
Integer GetWorkflowId()Returns
| Type | Description |
|---|---|
| Integer | Workflow Id. |
GetWorkflowStepId()
Gets the workflow step this instance belongs to.
Declaration
Integer GetWorkflowStepId()Returns
| Type | Description |
|---|---|
| Integer | WorkflowStep Id. |
GetWorkflowStepOptionId()
Gets the primary key (ID) for the WorkflowStepOption.
Declaration
Integer GetWorkflowStepOptionId()Returns
| Type | Description |
|---|---|
| Integer | WorkflowStepOption Id. |
SetName(String)
Sets the name of this option.
Declaration
Void SetName(String name)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | The name to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetOptionType(WorkflowSplitOptionType)
Sets the type of option.
Declaration
Void SetOptionType(WorkflowSplitOptionType optionType)Parameters
| Type | Name | Description |
|---|---|---|
| WorkflowSplitOptionType | optionType | The option type to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetRank(Integer)
Sets the step order.
Declaration
Void SetRank(Integer rank)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | rank | The rank to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetSteps(NSWorkflowStepBase[])
Sets the steps to execute if this option/path is selected.
Declaration
Void SetSteps(NSWorkflowStepBase[] steps)Parameters
| Type | Name | Description |
|---|---|---|
| NSWorkflowStepBase[] | steps | The workflow steps to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetWorkflowId(Integer)
Sets the workflow id.
Declaration
Void SetWorkflowId(Integer workflowId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | workflowId | The workflow ID to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetWorkflowStepId(Integer)
Sets the workflow step this instance belongs to.
Declaration
Void SetWorkflowStepId(Integer workflowStepId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | workflowStepId | The workflow step ID to set. |
Returns
| Type | Description |
|---|---|
| Void |
SetWorkflowStepOptionId(Integer)
Sets the primary key (ID) for the WorkflowStepOption.
Declaration
Void SetWorkflowStepOptionId(Integer workflowStepOptionId)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | workflowStepOptionId | The workflow step option ID to set. |
Returns
| Type | Description |
|---|---|
| Void |