IWorkState Interface

Represents a stage of a Workflow. Transitions push a Page from one workstate to another.

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

Syntax

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

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

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

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

The IWorkState 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 the workstate.
	Icon	Gets and sets the icon of a workstate. For visual editing only.
	IsActive	Gets and sets whether this workstate is active. The CMS uses this property to filter inactive Pages from a user's assignments pane. If a the workstate page currently on is not active, a user won't see it in the assignments pane.
	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)

Methods

	Name	Description
	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)

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)

Example

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

XML

<WorkState ID="WorkStates/1" Name="Initial" />