ITransition Interface

Ingeniux CMS Content Store API

Represents a path between two Work States. When a Workflow advances from one workstate to another, it goes through a transition.

Transitions allow for ownership change of a page in workflow. Transitions can also can execute built-in or custom Actions.

Transitions are defined in Workflow Definitions and carried out in Workflow Instances.

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

Syntax

C++

Copy

public interface ITransition : IEntity, 
	IEntityEvents

Public Interface ITransition
	Inherits IEntity, IEntityEvents

public interface class ITransition : IEntity, 
	IEntityEvents

type ITransition =  
    interface
        interface IEntity
        interface IEntityEvents
    end

The ITransition type exposes the following members.

Properties

	Name	Description
	Actions	Gets the collection of Actions in this transition.
	AllowNextGroupToAdvance	Gets and sets whether Members of the next group in the transition can advance the page.
	AssignToGroupOnly	Gets and sets whether the transition only assigns the Page to a Group.
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	CurrentState	Gets and sets the Work State before the Workflow advances through this transition. Transition is only available for Workflow to advance through, if Workflow is currently on this Work state.
	DefaultUser	Gets and sets the default User to whom to assign the Page in Workflow when the transition advances to the next workstate. The transition doesn't automatically assign the Page to this User; It is only a recommendation from the transition on whom should be assigned the Page.
	Definition	Gets the Workflow Definition to which this transition belongs.
	Description	Gets and sets the description of transition.
	DisallowDefaultUserOverride	Gets and sets whether a Page can be assigned to a different User, but only if the Default User is specified in this transition.
	IsDefault	Gets and sets whether the transition is the default for a given Work State.
	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.)
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	NextGroup	Gets and sets the next Group to which page assignments are restricted when the transition advances to the next workstate. The DefaultUser must be a member of this group.
	NextState	Gets and sets the Work State that the Workflow will be on after advancing through this transition.
	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.)
	Trigger	Gets and sets the type of Trigger associated with this transition. Decides where the transition is executed.
	UIParameters	Gets the behavior settings on for transitions on the Ingeniux CMS user interface. Actual changes will be performed on the property value. These settings decide this Workflow's icon on the toolbar, the "Advance" button drop-down menu, and the enter/exit prompt dialogs settings.

Top

Methods

	Name	Description
	ActionsCount	Gets the count of Actions in this transition
	AddAction	Adds a new Action to the transition, at the end of the list.
	RemoveAction	Removes an Action from a transition.
	ReorderActions	Reorders Actions in the transition. This changes their order of execution.
	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

Examples

Serialization of a transition instance matches the transition entries in the workflowdefinitions.xml file in previous-generation CMS content:

Copy

<Transition CurrentStateID="WorkStates/1" Description="" ID="WorkflowTransition_WorkflowDefinitions/33_1" IsDefault="true" 
    Name="Initial" NextGroupID="UserGroups/4" NextStateID="WorkStates/4" 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>

Reference

Ingeniux.CMS Namespace

Ingeniux.CMSIWorkflowDefinition

Ingeniux.CMSIWorkflow

Ingeniux.CMSIWorkState