Class NSWorkflowGoal

Carrier object for WorkflowGoal.

Syntax

Constructors

NSWorkflowGoal()

Initializes a new instance of the NSWorkflowGoal class.

Declaration

NSWorkflowGoal

Methods

GetGoalType()

Gets the workflow goal type.

Declaration

NSWorkflowGoalType GetGoalType()

Returns

Type	Description
NSWorkflowGoalType	Goal type.

GetRestrictionGroups()

Gets the restrictions (can be multiple groups) that make up the Workflow goal criteria.

Declaration

NSArchiveRestrictionGroup[] GetRestrictionGroups()

Returns

Type	Description
NSArchiveRestrictionGroup[]	Array of restriction groups.

GetWorkflowGoalId()

Gets the primary key (ID) for the WorkflowGoal.

Declaration

Integer GetWorkflowGoalId()

Returns

Type	Description
Integer	WorkflowGoal Id.

GetWorkflowId()

Gets the ID of the flow this goal belongs to.

Declaration

Integer GetWorkflowId()

Returns

Type	Description
Integer	Workflow ID.

SetGoalType(NSWorkflowGoalType)

Sets the workflow goal type.

Declaration

Void SetGoalType(NSWorkflowGoalType goalType)

Parameters

Type	Name	Description
NSWorkflowGoalType	goalType	The goal type to set.

Returns

Type	Description

SetRestrictionGroups(NSArchiveRestrictionGroup[])

Sets the restrictions that make up the Workflow goal criteria.

Declaration

Void SetRestrictionGroups(NSArchiveRestrictionGroup[] restrictionGroups)

Parameters

Type	Name	Description
NSArchiveRestrictionGroup[]	restrictionGroups	The restriction groups to set.

Returns

Type	Description

SetWorkflowGoalId(Integer)

Sets the primary key (ID) for the WorkflowGoal.

Declaration

Void SetWorkflowGoalId(Integer workflowGoalId)

Parameters

Type	Name	Description
Integer	workflowGoalId	The workflow goal ID to set.

Returns

Type	Description

SetWorkflowId(Integer)

Sets the ID of the flow this goal belongs to.

Declaration

Void SetWorkflowId(Integer workflowId)

Parameters

Type	Name	Description
Integer	workflowId	The workflow ID to set.

Returns

Type	Description