WorkflowManager Class

Class for managing the workflow procedure.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractManager
    CMS.WorkflowEngine.AbstractWorkflowManager<TreeNode, BaseInfo, WorkflowActionEnum>
      CMS.DocumentEngine.WorkflowManager

Namespace: CMS.DocumentEngine
Assembly: CMS.DocumentEngine (in CMS.DocumentEngine.dll) Version: 8.2.23

Syntax

public class WorkflowManager : AbstractWorkflowManager<TreeNode, BaseInfo, WorkflowActionEnum>

The WorkflowManager type exposes the following members.

Constructors

	Name	Description
Public method	WorkflowManager()	Obsolete. Constructor
Protected method	WorkflowManager(TreeProvider)	Constructor - Creates workflow manager.

Methods

	Name	Description
Public method	ArchiveDocument	Archives the document, returns the last step info.
Protected method	ArchiveDocumentInternal	Archives the document, returns the last step info.
Public method	CanUserManageWorkflow	Indicates if user can manage workflow.
Protected method	CanUserManageWorkflowInternal	Indicates if user can manage workflow.
Protected method	CreateActionArgumentsInternal	Creates action arguments. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	CreateActionsExecutorInternal	Creates action executor with prefilled parameters. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	EnsureStepInfo	Ensures workflow step for given document.
Protected method	EnsureStepInfoInternal	Ensures workflow step for given document.
Protected method	EvaluateSourcePointsInternal	Evaluates source points with given macro resolver (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	EvaluateTransitions(WorkflowStepInfo, UserInfo, Int32, MacroResolver)	Evaluates list of existing transitions for given workflow step and returns either one best match or multiple transitions matched (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	EvaluateTransitions(WorkflowStepInfo, UserInfo, Int32, MacroResolver, WorkflowTransitionTypeEnum)	Evaluates list of existing transitions for given workflow step and returns either one best match or multiple transitions matched (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetActionStatus	Gets action status
Protected method	GetActionStatusInternal	Gets action status (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetActionStatusInternal(InfoType, StateInfoType).)
Protected method	GetBasicResolverInternal	Gets basic resolver for evaluation of transitions and source points (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	GetCurrentStepInternal	Always gets instance of current workflow step. (Also checks document for required settings.)
Protected method	GetEditorEmailInternal	Gets the document editor e-mail (user that approved the document edit step)
Public method	GetEmailResolver	Get resolver for e-mail sending. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetEmailResolver(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, String, String).)
Protected method	GetEmailResolverInternal	Get resolver for e-mail sending.
Protected method	GetEmailTemplateInternal	Gets e-mail template name and default subject to be used for given action
Protected method	GetEvalResolverInternal	Gets resolver for evaluation of transitions and source points (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).)
Public method	GetFirstWorkflowStep	Returns first workflow step for given node.
Protected method	GetFirstWorkflowStepInternal	Returns first workflow step for given node.
Public method Static member	GetInstance	Gets the instance of the manager.
Public method	GetNextStepInfo	Returns list of next steps for given node.
Protected method	GetNextStepInfoInternal(TreeNode, WorkflowStepInfo)	Returns list of next steps for given node.
Protected method	GetNextStepInfoInternal(TreeNode, BaseInfo, WorkflowStepInfo, UserInfo)	Returns list of next steps for given object. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetNextStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo).)
Public method	GetNextSteps(TreeNode)	Returns list of next steps for given node.
Public method	GetNextSteps(TreeNode, WorkflowStepInfo)	Returns list of next steps for given node.
Public method	GetNodeWorkflow	Returns the workflow for the specified node.
Protected method	GetNodeWorkflowInternal	Returns the workflow for the specified node.
Public method	GetNodeWorkflowScope	Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected method	GetNodeWorkflowScopeInternal	Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected method	GetNotificationEmailRecipientsInternal	Gets list of user e-mail addresses to send the general notification e-mail
Protected method	GetPreviousStepInfoInternal	Returns previous step information for given node. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetPreviousStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, Boolean).)
Public method	GetPreviousSteps	Returns list of previous steps for current workflow cycle
Protected method	GetPreviousStepsInternal	Returns list of previous steps for current workflow cycle (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.GetPreviousStepsInternal(InfoType, StateInfoType, WorkflowStepInfo).)
Public method	GetPublishedWorkflowStep	Returns published workflow step for given node.
Protected method	GetPublishedWorkflowStepInternal	Returns published workflow step for given node.
Protected method	GetStepInboundTransitionsInternal	Gets transitions leading into given step (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetStepInfo	Gets step information for given document.
Protected method	GetStepInfoInternal	Gets step information for given document.
Public method	GetStepTransitions(WorkflowStepInfo)	Gets all workflow step transitions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)	Gets workflow step transitions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	GetUsersWhoCanApprove(TreeNode, SourcePoint, String, String, Int32, String)	Returns list of users who can approve node in the current workflow step. Users who are approved due to generic roles are not included to the result.
Public method	GetUsersWhoCanApprove(TreeNode, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)	Returns list of all the users who can approve node in the current workflow step.
Protected method	GetUsersWhoCanApproveInternal(TreeNode, SourcePoint, String, String, Int32, String)	Returns list of users who can approve node in the current workflow step. Users who are approved due to generic roles are not included to the result.
Protected method	GetUsersWhoCanApproveInternal(TreeNode, SourcePoint, Boolean, Boolean, Boolean, String, String, Int32, String)	Returns list of all the users who can approve node in the current workflow step.
Public method	GetWorkflowEmailRecipients	Gets list of user e-mail addresses to send the workflow e-mail
Protected method	GetWorkflowEmailRecipientsInternal	Gets list of user e-mail addresses to send the workflow e-mail
Protected method	HandleStepInternal	Handles step additional actions (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	HandleStepTimeout	Handles step timeout
Protected method	HandleStepTimeoutInternal	Handles step timeout (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	ChangeManagerType<OriginalType>	Changes the default manager type to the given type (Inherited from AbstractManager.)
Public method	ChangeManagerTypeTo	Changes the manager type to the given type (Overrides AbstractManager.ChangeManagerTypeTo(Type).)
Public method	CheckStepPermissions(TreeNode, WorkflowActionEnum)	Returns true if current user can approve or reject given node in its current workflow step.
Public method	CheckStepPermissions(TreeNode, UserInfo, WorkflowActionEnum)	Returns true if given user can approve or reject given node in its current workflow step.
Protected method	CheckStepPermissionsInternal	Returns true if given user can approve or reject given node in its current workflow step.
Protected method	LogHopsReachedWarningInternal	Logs warning about maximum hops reached (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogMessage	Logs custom message to event log. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	LogMessageInternal	Logs message to the event log (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	LogMissingConnectionWarningInternal	Logs warning about missing connection (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	LogWorkflowHistory	Logs specified action in the workflow history record.
Public method	MoveDocument	Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected method	MoveDocumentInternal	Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected method	MoveStepInternal(TreeNode, WorkflowStepInfo)	Moves the specified node to the first step without automatic transition in the workflow and returns the final step.
Protected method	MoveStepInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo)	Moves the specified object to the first step without automatic transition in the workflow and returns the final step. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	MoveToFirstStep	Moves the specified node to the first step in the workflow and returns the step.
Protected method	MoveToFirstStepInternal	Moves the specified node to the first step in the workflow and returns the step.
Public method	MoveToNextStep	Moves the specified node to the next step in the workflow and returns new step.
Protected method	MoveToNextStepInternal	Moves the specified node to the next step in the workflow and returns new step.
Public method	MoveToPreviousSpecificStep	Moves the specified node to the specified previous step in the workflow and returns the step.
Public method	MoveToPreviousStep	Moves the specified node to the previous step in the workflow and returns the step.
Protected method	MoveToPreviousStepInternal	Moves the specified node to the previous step in the workflow and returns StepID of the new step.
Public method	MoveToPublishedStep	Automatically publishes given document. (Moves document to published step.)
Protected method	MoveToPublishedStepInternal	Moves document directly to published step. (Publishes the document without going through all the steps.)
Public method	MoveToSpecificNextStep	Moves the specified node to the specified next step in the workflow and returns workflow step.
Public method	MoveToSpecificStep(TreeNode, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
Public method	MoveToSpecificStep(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
Protected method	MoveToSpecificStepInternal(TreeNode, BaseInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, WorkflowActionEnum)	Moves the specified node to the specified step in the workflow and returns workflow step. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.MoveToSpecificStepInternal(InfoType, StateInfoType, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, ActionEnumType).)
Protected method	MoveToSpecificStepInternal(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, WorkflowActionEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
Protected method	MoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns the step.
Protected method	MoveToStepInternal(TreeNode, BaseInfo, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, Boolean)	Moves the specified node to the specified step in the workflow and returns the step. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.MoveToStepInternal(InfoType, StateInfoType, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum, Boolean).)
Protected method	MoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, Boolean)	Moves the specified node to the specified step in the workflow and returns the step.
Protected method	ProcessActionInternal	Processes action connected to given step. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.ProcessActionInternal(WorkflowActionEventArgs<InfoType, StateInfoType, ActionEnumType>).)
Public method	ProcessActions	Processes all actions in scope. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	ProcessActionsInternal	Processes all actions in scope. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	PropagateTreeProviderInternal	Propagates tree provider
Public method	PublishDocument	Publishes the document, returns the last step info.
Protected method	PublishDocumentInternal	Publishes the document, returns the last step info.
Public method	SendWorkflowEmails(WorkflowEmailSettings)	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public method	SendWorkflowEmails(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)	Sends the workflow email for the specified document node.
Protected method	SendWorkflowEmailsInternal(WorkflowEmailSettings)	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected method	SendWorkflowEmailsInternal(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)	Sends the workflow email for the specified document node.
Public method	SetActionStatus	Sets action status
Protected method	SetActionStatusInternal	Sets action status (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.SetActionStatusInternal(InfoType, StateInfoType, String).)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ApplicationUrl	Application URL for macro resolver (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected property	CurrentHops	Number of currently processed hops (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	EventLogSource	Event log source name. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	CheckPermissions	Indicates if step permissions should be checked when the step is moved. (Overrides AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.CheckPermissions.)
Public property	MacroResolver	Macro resolver instance. (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Protected property	ScopesOrderBy	Default scopes order by expression to handle scope priorities.
Public property	SendEmails	Indicates if notification e-mails should be sent (Inherited from AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>.)
Public property	TreeProvider	TreeProvider instance.
Protected property	VersionManager	Version manager instance.