IWorkflow Interface

Represents the an instance of a Workflow Definition associated with a single Page. Once a Page is added to a Workflow, a new instance of the Workflow object is created and attached to the Page. This allows precise control of the Page's lifecycle. It's also a good way to track the history of actions that occur on the Page.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.5.94

Syntax

C++

Copy

public interface IWorkflow : IEntity<IWorkflowManager>, 
	IEntity, IEntityEvents, IWorkflowTransitionEvents

Public Interface IWorkflow
	Inherits IEntity(Of IWorkflowManager), IEntity, IEntityEvents, 
	IWorkflowTransitionEvents

public interface class IWorkflow : IEntity<IWorkflowManager^>, 
	IEntity, IEntityEvents, IWorkflowTransitionEvents

type IWorkflow =  
    interface
        interface IEntity<IWorkflowManager>
        interface IEntity
        interface IEntityEvents
        interface IWorkflowTransitionEvents
    end

The IWorkflow type exposes the following members.

Properties

	Name	Description
	Archived	Gets the archived value of this entity (Inherited from IEntity.)
	Asset
	AssignedUser	Gets the User to whom the Page this workflow holds is assigned.
	Comment	Gets the user comments from the last Advancement of this workflow.
	ContentItem
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	CurrentGroup	Gets the current group to which page assignments are restricted in the current Work State.
	CurrentWorkState	Gets the workflow's current Work State.
	DefaultTransition	Gets the default transition of this workflow's CurrentWorkState.
	DontExecuteActions	Gets and sets whether or not to execute Actions during a workflow advance.
	IsActive	Gets whether the workflow's current Work State is active.
	LastModified	Gets the date when the entity was most recently modified. (Inherited from IEntity.)
	LastModifiedUser	Gets the ID of the User who lasted edited the entity. (Inherited from IEntity.)
	Locked	Gets and sets whether this workflow is in lockdown mode. When a workflow is in lockdown mode, advancing it throws an error.
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager.)
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	Page	Gets the Page associated with this workflow.
	Session	Gets the session that retrieved this entity. An entity is always session-specific. (Inherited from IEntity.)
	SessionId	Gets the unique ID of the session that retrieved this entity. (Inherited from IEntity.)
	WorkflowDefinition	Gets the Workflow Definition from which the workflow was created.

Top

Methods

	Name	Description
	Advance	Advances this workflow from its current Work State to the next Work State, using a specified Transition. Meanwhile, determines which User to whom to assign the workflow, and whether to perform Actions.
	AllowedTransitions	Gets the allowed Transitions to execute from the workflow's current Work State.
	AssignUser	Assigns the Page this workflow holds to a specific User.
	Jump	Puts the workflow directly on the specified Work State without going through any Transitions.
	LogEntries	Returns the collection of Log entries on this workflow. These logs entries record the history of Workflow Transitions.
	LogEntriesCount	Gets the count of Log entries on this workflow.
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity.)
	ValidateData	Validates this entity's data. Implemented by concrete inheriting types. (Inherited from IEntity.)
	ValidateUserPermission	Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity. (Inherited from IEntity.)

Top

Events

	Name	Description
	AfterEntitySave	This event is fired after a Entity object is saved. (Inherited from IEntityEvents.)
	AfterWorkflowAdvance	Called after all actions are executed and Transition has occured. Not called on a Bridge action. (Inherited from IWorkflowTransitionEvents.)
	AfterWorkflowAdvanceAsset	Called after all actions are executed and Transition has occured. Not called on a Bridge action. (Inherited from IWorkflowTransitionEvents.)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents.)
	BeforeWorkflowAdvance	Called before a Transition occurs. (Inherited from IWorkflowTransitionEvents.)
	BeforeWorkflowAdvanceAsset	Called before a Transition occurs. (Inherited from IWorkflowTransitionEvents.)

Top

Examples

Serialization of a Workflow instance matches an entry in the Workflows.xml from previous-generation CMS content:

XML

Copy

<WorkFlow Comment="Existing page added to workflow" CurrentStateID="WorkStates/2" 
  TransitionID="WorkflowTransition_WorkflowDefinitions/33_1" CurrentGroupID="UserGroups/2" 
  WorkFlowDefinitionID="WorkflowDefintions/4" PageID="x1551" Name="News Approval Workflow"/>

Please note that the "Name" attribute value is changed from generic "Page WF (x1551)" to the name of the Workflow Definition.

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIWorkflowDefinition

Ingeniux.CMSIPage