Click or drag to resize
AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType Class
Abstract class for managing the workflow procedure.
Inheritance Hierarchy

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 12.0.0
Syntax
C#
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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyApplicationUrl
Application URL for macro resolver
Public propertyCheckPermissions
Indicates if step permissions should be checked when the step is moved.
Protected propertyCurrentHops
Number of currently processed hops
Public propertyEventLogSource
Event log source name.
Public propertyMacroResolver
Macro resolver instance.
Public propertySendEmails
Indicates if notification e-mails should be sent
Public propertyStatic memberSendEmailToModerator
Returns whether the e-mails should be sent to the current moderator (reflects the CMSWorkflowSendEmailToModerator web.config settings).
Top
Methods
  NameDescription
Protected methodChangeManagerTypeOriginalType
Changes the default manager type to the given type
(Inherited from AbstractManager.)
Public methodChangeManagerTypeTo
Changes the manager type to the given type
(Inherited from AbstractManager.)
Protected methodCreateActionArgumentsInternal(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, String)
Creates action arguments with prefilled parameters.
Protected methodCreateActionArgumentsInternal(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType, String)
Creates action arguments.
Protected methodEvaluateSourcePointsInternal
Evaluates source points with given macro resolver
Public methodEvaluateTransitions(WorkflowStepInfo, UserInfo, Int32, MacroResolver)
Evaluates list of existing transitions for given workflow step and returns either one best match or multiple transitions matched
Public methodEvaluateTransitions(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 methodGetActionStatusInternal
Gets action status
Protected methodGetBasicResolverInternal
Gets basic resolver for evaluation of transitions and source points
Public methodGetEmailResolver
Get resolver for e-mail sending.
Protected methodGetEvalResolverInternal
Gets resolver for evaluation of transitions and source points
Protected methodGetNextStepInfoInternal
Returns list of next steps for given object.
Protected methodGetPreviousStepInfoInternal
Returns previous step information for given node.
Protected methodGetPreviousStepsInternal
Returns list of previous steps for current workflow cycle
Protected methodGetStepInboundTransitionsInternal
Gets transitions leading into given step
Public methodGetStepTransitions(WorkflowStepInfo)
Gets all workflow step transitions
Public methodGetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)
Gets workflow step transitions
Protected methodHandleStepInternal
Handles step additional actions
Protected methodHandleStepTimeoutInternal
Handles step timeout
Protected methodLogHopsReachedWarningInternal
Logs warning about maximum hops reached
Public methodLogMessage
Logs custom message to event log.
Protected methodLogMessageInternal
Logs message to the event log
Protected methodLogMissingConnectionWarningInternal
Logs warning about missing connection
Protected methodMoveStepInternal
Moves the specified object to the first step without automatic transition in the workflow and returns the final step.
Protected methodMoveToSpecificStepInternal
Moves the specified object to the specified step in the workflow and returns workflow step.
Protected methodMoveToStepInternal
Moves the specified object to the specified step in the workflow and returns the step.
Protected methodProcessActionInternal
Processes action connected to given step.
Public methodProcessActions
Processes all actions in scope.
Protected methodProcessActionsInternal
Processes all actions in scope.
Public methodSendWorkflowEmails
Sends the workflow e-mails to given recipients.
Protected methodSendWorkflowEmailsInternal
Sends the workflow e-mails to given recipients.
Protected methodSetActionStatusInternal
Sets action status
Top
See Also