AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType> Class

Abstract class for managing the workflow procedure.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractManager
    CMS.WorkflowEngine.AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>
      CMS.Automation.AbstractAutomationManager<InfoType>
      CMS.DocumentEngine.WorkflowManager

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

Syntax

public abstract class AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType> : AbstractManager
where InfoType : BaseInfo
where StateInfoType : BaseInfo
where ActionEnumType : struct, new(), IConvertible

Type Parameters

InfoType

StateInfoType

ActionEnumType

The AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType> type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractWorkflowManager<InfoType, StateInfoType, ActionEnumType>

Methods

	Name	Description
Protected method	CreateActionArgumentsInternal	Creates action arguments.
Protected method	CreateActionsExecutorInternal	Creates action executor with prefilled parameters.
Protected method	EvaluateSourcePointsInternal	Evaluates source points with given macro resolver
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
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
Protected method	GetActionStatusInternal	Gets action status
Protected method	GetBasicResolverInternal	Gets basic resolver for evaluation of transitions and source points
Public method	GetEmailResolver	Get resolver for e-mail sending.
Protected method	GetEvalResolverInternal	Gets resolver for evaluation of transitions and source points
Protected method	GetNextStepInfoInternal	Returns list of next steps for given object.
Protected method	GetPreviousStepInfoInternal	Returns previous step information for given node.
Protected method	GetPreviousStepsInternal	Returns list of previous steps for current workflow cycle
Protected method	GetStepInboundTransitionsInternal	Gets transitions leading into given step
Public method	GetStepTransitions(WorkflowStepInfo)	Gets all workflow step transitions
Public method	GetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)	Gets workflow step transitions
Protected method	HandleStepInternal	Handles step additional actions
Protected method	HandleStepTimeoutInternal	Handles step timeout
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 (Inherited from AbstractManager.)
Protected method	LogHopsReachedWarningInternal	Logs warning about maximum hops reached
Public method	LogMessage	Logs custom message to event log.
Protected method	LogMessageInternal	Logs message to the event log
Protected method	LogMissingConnectionWarningInternal	Logs warning about missing connection
Protected method	MoveStepInternal	Moves the specified object to the first step without automatic transition in the workflow and returns the final step.
Protected method	MoveToSpecificStepInternal	Moves the specified object to the specified step in the workflow and returns workflow step.
Protected method	MoveToStepInternal	Moves the specified object to the specified step in the workflow and returns the step.
Protected method	ProcessActionInternal	Processes action connected to given step.
Public method	ProcessActions	Processes all actions in scope.
Protected method	ProcessActionsInternal	Processes all actions in scope.
Public method	SendWorkflowEmails	Sends the workflow e-mails to given recipients.
Protected method	SendWorkflowEmailsInternal	Sends the workflow e-mails to given recipients.
Protected method	SetActionStatusInternal	Sets action status

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
Protected property	CurrentHops	Number of currently processed hops
Public property	EventLogSource	Event log source name.
Public property	CheckPermissions	Indicates if step permissions should be checked when the step is moved.
Public property	MacroResolver	Macro resolver instance.
Public property	SendEmails	Indicates if notification e-mails should be sent
Public property Static member	SendEmailToModerator	Returns whether the e-mails should be sent to the current moderator (reflects the CMSWorkflowSendEmailToModerator web.config settings).