WorkflowManager MembersKentico 8.0 API Reference
The WorkflowManager type exposes the following members.
Constructors

  NameDescription
Public methodWorkflowManager Obsolete.
Constructor
Protected methodWorkflowManager(TreeProvider)
Constructor - Creates workflow manager.
Back to Top
Methods

  NameDescription
Public methodArchiveDocument
Archives the document, returns the last step info.
Protected methodArchiveDocumentInternal
Archives the document, returns the last step info.
Public methodCanUserManageWorkflow
Indicates if user can manage workflow.
Protected methodCanUserManageWorkflowInternal
Indicates if user can manage workflow.
Protected methodCreateActionArgumentsInternal
Creates action arguments.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodCreateActionsExecutorInternal
Creates action executor with prefilled parameters.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodEnsureStepInfo
Ensures workflow step for given document.
Protected methodEnsureStepInfoInternal
Ensures workflow step for given document.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodEvaluateSourcePointsInternal
Evaluates source points with given macro resolver
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
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
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
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
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodGetActionStatus
Gets action status
Protected methodGetActionStatusInternal
Gets action status
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetActionStatusInternal(InfoType, StateInfoType).)
Protected methodGetBasicResolverInternal
Gets basic resolver for evaluation of transitions and source points
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodGetCurrentStepInternal
Always gets instance of current workflow step. (Also checks document for required settings.)
Protected methodGetEditorEmailInternal
Gets the document editor e-mail (user that approved the document edit step)
Public methodGetEmailResolver
Get resolver for e-mail sending.
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetEmailResolver(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, String, String).)
Protected methodGetEmailResolverInternal
Get resolver for e-mail sending.
Protected methodGetEmailTemplateInternal
Gets e-mail template name and default subject to be used for given action
Protected methodGetEvalResolverInternal
Gets resolver for evaluation of transitions and source points
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).)
Public methodGetFirstWorkflowStep
Returns first workflow step for given node.
Protected methodGetFirstWorkflowStepInternal
Returns first workflow step for given node.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodStatic memberGetInstance
Gets the instance of the manager.
Public methodGetNextStepInfo
Returns list of next steps for given node.
Protected methodGetNextStepInfoInternal(TreeNode, WorkflowStepInfo)
Returns list of next steps for given node.
Protected methodGetNextStepInfoInternal(TreeNode, BaseInfo, WorkflowStepInfo, UserInfo)
Returns list of next steps for given object.
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetNextStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo).)
Public methodGetNextSteps(TreeNode)
Returns list of next steps for given node.
Public methodGetNextSteps(TreeNode, WorkflowStepInfo)
Returns list of next steps for given node.
Public methodGetNodeWorkflow
Returns the workflow for the specified node.
Protected methodGetNodeWorkflowInternal
Returns the workflow for the specified node.
Public methodGetNodeWorkflowScope
Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected methodGetNodeWorkflowScopeInternal
Returns the workflow scope info for the given node, or null when the node does not support workflow.
Protected methodGetNotificationEmailRecipientsInternal
Gets list of user e-mail addresses to send the general notification e-mail
Protected methodGetPreviousStepInfoInternal
Returns previous step information for given node.
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetPreviousStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, Boolean).)
Public methodGetPreviousSteps
Returns list of previous steps for current workflow cycle
Protected methodGetPreviousStepsInternal
Returns list of previous steps for current workflow cycle
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  GetPreviousStepsInternal(InfoType, StateInfoType, WorkflowStepInfo).)
Public methodGetPublishedWorkflowStep
Returns published workflow step for given node.
Protected methodGetPublishedWorkflowStepInternal
Returns published workflow step for given node.
Protected methodGetStepInboundTransitionsInternal
Gets transitions leading into given step
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodGetStepInfo
Gets step information for given document.
Protected methodGetStepInfoInternal
Gets step information for given document.
Public methodGetStepTransitions(WorkflowStepInfo)
Gets all workflow step transitions
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodGetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)
Gets workflow step transitions
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodGetUsersWhoCanApprove(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 methodGetUsersWhoCanApprove(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 methodGetUsersWhoCanApproveInternal(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 methodGetUsersWhoCanApproveInternal(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 methodGetWorkflowEmailRecipients
Gets list of user e-mail addresses to send the workflow e-mail
Protected methodGetWorkflowEmailRecipientsInternal
Gets list of user e-mail addresses to send the workflow e-mail
Protected methodHandleStepInternal
Handles step additional actions
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodHandleStepTimeout
Handles step timeout
Protected methodHandleStepTimeoutInternal
Handles step timeout
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodChangeManagerType OriginalType 
Changes the default manager type to the given type
(Inherited from AbstractManager.)
Public methodChangeManagerTypeTo
Changes the manager type to the given type
(Overrides AbstractManager ChangeManagerTypeTo(Type).)
Public methodCheckStepPermissions(TreeNode, WorkflowActionEnum)
Returns true if current user can approve or reject given node in its current workflow step.
Public methodCheckStepPermissions(TreeNode, UserInfo, WorkflowActionEnum)
Returns true if given user can approve or reject given node in its current workflow step.
Protected methodCheckStepPermissionsInternal
Returns true if given user can approve or reject given node in its current workflow step.
Protected methodLogHopsReachedWarningInternal
Logs warning about maximum hops reached
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodLogMessage
Logs custom message to event log.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodLogMessageInternal
Logs message to the event log
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodLogMissingConnectionWarningInternal
Logs warning about missing connection
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodLogWorkflowHistory
Logs specified action in the workflow history record.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodMoveDocument
Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected methodMoveDocumentInternal
Moves the document to the next step until the given condition is satisfied, returns the last step info.
Protected methodMoveStepInternal(TreeNode, WorkflowStepInfo)
Moves the specified node to the first step without automatic transition in the workflow and returns the final step.
Protected methodMoveStepInternal(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 methodMoveToFirstStep
Moves the specified node to the first step in the workflow and returns the step.
Protected methodMoveToFirstStepInternal
Moves the specified node to the first step in the workflow and returns the step.
Public methodMoveToNextStep
Moves the specified node to the next step in the workflow and returns new step.
Protected methodMoveToNextStepInternal
Moves the specified node to the next step in the workflow and returns new step.
Public methodMoveToPreviousStep(TreeNode, String)
Moves the specified node to the previous step in the workflow and returns the step.
Public methodMoveToPreviousStep(TreeNode, WorkflowStepInfo, String)
Moves the specified node to the specified previous step in the workflow and returns the step.
Protected methodMoveToPreviousStepInternal
Moves the specified node to the previous step in the workflow and returns StepID of the new step.
Public methodMoveToPublishedStep
Automatically publishes given document. (Moves document to published step.)
Protected methodMoveToPublishedStepInternal
Moves document directly to published step. (Publishes the document without going through all the steps.)
Public methodMoveToSpecificNextStep
Moves the specified node to the specified next step in the workflow and returns workflow step.
Public methodMoveToSpecificStep(TreeNode, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Public methodMoveToSpecificStep(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Protected methodMoveToSpecificStepInternal(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 methodMoveToSpecificStepInternal(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, WorkflowActionEnum)
Moves the specified node to the specified step in the workflow and returns workflow step.
Protected methodMoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)
Moves the specified node to the specified step in the workflow and returns the step.
Protected methodMoveToStepInternal(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 methodMoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, Boolean)
Moves the specified node to the specified step in the workflow and returns the step.
Protected methodProcessActionInternal
Processes action connected to given step.
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  ProcessActionInternal(WorkflowActionEventArgs InfoType, StateInfoType, ActionEnumType ).)
Public methodProcessActions
Processes all actions in scope.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodProcessActionsInternal
Processes all actions in scope.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodPropagateTreeProviderInternal
Propagates tree provider
Public methodPublishDocument
Publishes the document, returns the last step info.
Protected methodPublishDocumentInternal
Publishes the document, returns the last step info.
Public methodSendWorkflowEmails(WorkflowEmailSettings)
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public methodSendWorkflowEmails(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)
Sends the workflow email for the specified document node.
Protected methodSendWorkflowEmailsInternal(WorkflowEmailSettings)
Sends the workflow e-mails to given recipients.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected methodSendWorkflowEmailsInternal(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)
Sends the workflow email for the specified document node.
Public methodSetActionStatus
Sets action status
Protected methodSetActionStatusInternal
Sets action status
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  SetActionStatusInternal(InfoType, StateInfoType, String).)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Back to Top
Properties

  NameDescription
Public propertyApplicationUrl
Application URL for macro resolver
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected propertyCurrentHops
Number of currently processed hops
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public propertyEventLogSource
Event log source name.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public propertyCheckPermissions
Indicates if step permissions should be checked when the step is moved.
(Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType  CheckPermissions.)
Public propertyMacroResolver
Macro resolver instance.
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Protected propertyScopesOrderBy
Default scopes order by expression to handle scope priorities.
Public propertySendEmails
Indicates if notification e-mails should be sent
(Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
Public propertyTreeProvider
TreeProvider instance.
Protected propertyVersionManager
Version manager instance.
Back to Top
See Also