IWorkflowDefinition Interface

Represents a definition of workflow. Defines a Transitions tree/loop to move Pages through, the Users to assign page to, and the Actions to perform on these transitions.

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

Syntax

C++

Copy

public interface IWorkflowDefinition : IEntity<IWorkflowManager>, 
	IEntity, IEntityEvents

Public Interface IWorkflowDefinition
	Inherits IEntity(Of IWorkflowManager), IEntity, IEntityEvents

public interface class IWorkflowDefinition : IEntity<IWorkflowManager^>, 
	IEntity, IEntityEvents

type IWorkflowDefinition = 
    interface
        interface IEntity<IWorkflowManager>
        interface IEntity
        interface IEntityEvents
    end

The IWorkflowDefinition type exposes the following members.

Properties

	Name	Description
	Archived	Gets/sets the archived value of this entity (Inherited from IEntity)
	Created	Gets the entity's creation date. (Inherited from IEntity)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity)
	Description	Gets and sets the description of this Workflow Definition.
	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)
	Manager	Gets the manager that retrieved this entity instance. (Inherited from IEntityTManager)
	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)
	Transitions	Gets the collection of Transitions that belong to this Workflow Definition.

Top

Methods

	Name	Description
	AddTransition	Adds a new Transition to this Workflow Definition.
	InitialTransition	Retrieves the Transition that takes the Page from the initial Work State to the next state.
	RemoveTransition	Removes a Transition from the collection.
	Touch	Updated the entity's LastModified value to the current time. (Inherited from IEntity)
	Transition	Retrieves a Transition from the collection by its unique ID.
	TransitionByName	Retrieves a Transition from the collection by its name.
	TransitionsCount	Gets the count the Transitions in the collection.
	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)
	BeforeEntitySave	This event is fired before any Entity object is about to be saved. (Inherited from IEntityEvents)

Top

Remarks

Note the conceptual difference between a Workflow Definition and a workflow:

A Workflow Definition is the host of all the transition information.

A workflow is based on a workflow defintion and is specific to one Page, but it only holds the information on the current state, the most recent transition, and user comments on the most recent transition.

Example

Serialization of a workflow defintion matches a definition entry in the workflowdefinitions.xml file in previous-generation CMS site content:

XML

Copy

<WorkFlowDefinition Description="Used to track News Articles submitted through the website's entry form." 
    ID="WorkflowDefintions/1" Name="Anonymous News Submission">
  <Transitions>
    <Transition AllowNextGroupToAdvance="false" CurrentStateID="WorkStates/1" DefaultUserID="" Description="" 
        ID="WorkflowTransition_WorkflowDefinitions/1_1" IsDefault="true" Name="Initial" NextGroupID="UserGroups/3" 
        NextStateID="WorkStates/2" ToolbarIcon="" Trigger="OnCreate">
      <Actions NextID="1"/>
    </Transition>
    <Transition CurrentStateID="WorkStates/2" Description="" ID="WorkflowTransition_WorkflowDefinitions/33_1" 
        IsDefault="true" Name="Initial" NextGroupID="UserGroups/4" NextStateID="WorkStates/3" Trigger="OnCreate">
      <Actions NextID="4">
        <Action ID="action_1" Type="MarkForPublish"/>
        <Action ID="action_2" Type="CheckIn"/>
        <Action ID="action_3" Type="Republish"/>
      </Actions>
    </Transition>
  </Transitions>
</WorkFlowDefinition>

Reference

Ingeniux.CMS Namespace