WorkflowManager Members

Kentico 8.1 API Reference

The WorkflowManager type exposes the following members.

Constructors

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

Methods

	Name	Description
	ArchiveDocument	Archives the document, returns the last step info.
	ArchiveDocumentInternal	Archives the document, returns the last step info.
	CanUserManageWorkflow	Indicates if user can manage workflow.
	CanUserManageWorkflowInternal	Indicates if user can manage workflow.
	CreateActionArgumentsInternal	Creates action arguments. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	CreateActionsExecutorInternal	Creates action executor with prefilled parameters. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	EnsureStepInfo	Ensures workflow step for given document.
	EnsureStepInfoInternal	Ensures workflow step for given document.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	EvaluateSourcePointsInternal	Evaluates source points with given macro resolver (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	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 .)
	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 .)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetActionStatus	Gets action status
	GetActionStatusInternal	Gets action status (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetActionStatusInternal(InfoType, StateInfoType).)
	GetBasicResolverInternal	Gets basic resolver for evaluation of transitions and source points (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	GetCurrentStepInternal	Always gets instance of current workflow step. (Also checks document for required settings.)
	GetEditorEmailInternal	Gets the document editor e-mail (user that approved the document edit step)
	GetEmailResolver	Get resolver for e-mail sending. (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetEmailResolver(InfoType, StateInfoType, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowInfo, String, String).)
	GetEmailResolverInternal	Get resolver for e-mail sending.
	GetEmailTemplateInternal	Gets e-mail template name and default subject to be used for given action
	GetEvalResolverInternal	Gets resolver for evaluation of transitions and source points (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).)
	GetFirstWorkflowStep	Returns first workflow step for given node.
	GetFirstWorkflowStepInternal	Returns first workflow step for given node.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetInstance	Gets the instance of the manager.
	GetNextStepInfo	Returns list of next steps for given node.
	GetNextStepInfoInternal(TreeNode, WorkflowStepInfo)	Returns list of next steps for given node.
	GetNextStepInfoInternal(TreeNode, BaseInfo, WorkflowStepInfo, UserInfo)	Returns list of next steps for given object. (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetNextStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, UserInfo).)
	GetNextSteps(TreeNode)	Returns list of next steps for given node.
	GetNextSteps(TreeNode, WorkflowStepInfo)	Returns list of next steps for given node.
	GetNodeWorkflow	Returns the workflow for the specified node.
	GetNodeWorkflowInternal	Returns the workflow for the specified node.
	GetNodeWorkflowScope	Returns the workflow scope info for the given node, or null when the node does not support workflow.
	GetNodeWorkflowScopeInternal	Returns the workflow scope info for the given node, or null when the node does not support workflow.
	GetNotificationEmailRecipientsInternal	Gets list of user e-mail addresses to send the general notification e-mail
	GetPreviousStepInfoInternal	Returns previous step information for given node. (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetPreviousStepInfoInternal(InfoType, StateInfoType, WorkflowStepInfo, Boolean).)
	GetPreviousSteps	Returns list of previous steps for current workflow cycle
	GetPreviousStepsInternal	Returns list of previous steps for current workflow cycle (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType GetPreviousStepsInternal(InfoType, StateInfoType, WorkflowStepInfo).)
	GetPublishedWorkflowStep	Returns published workflow step for given node.
	GetPublishedWorkflowStepInternal	Returns published workflow step for given node.
	GetStepInboundTransitionsInternal	Gets transitions leading into given step (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	GetStepInfo	Gets step information for given document.
	GetStepInfoInternal	Gets step information for given document.
	GetStepTransitions(WorkflowStepInfo)	Gets all workflow step transitions (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	GetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum)	Gets workflow step transitions (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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.
	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.
	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.
	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.
	GetWorkflowEmailRecipients	Gets list of user e-mail addresses to send the workflow e-mail
	GetWorkflowEmailRecipientsInternal	Gets list of user e-mail addresses to send the workflow e-mail
	HandleStepInternal	Handles step additional actions (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	HandleStepTimeout	Handles step timeout
	HandleStepTimeoutInternal	Handles step timeout (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	ChangeManagerType OriginalType	Changes the default manager type to the given type (Inherited from AbstractManager.)
	ChangeManagerTypeTo	Changes the manager type to the given type (Overrides AbstractManager ChangeManagerTypeTo(Type).)
	CheckStepPermissions(TreeNode, WorkflowActionEnum)	Returns true if current user can approve or reject given node in its current workflow step.
	CheckStepPermissions(TreeNode, UserInfo, WorkflowActionEnum)	Returns true if given user can approve or reject given node in its current workflow step.
	CheckStepPermissionsInternal	Returns true if given user can approve or reject given node in its current workflow step.
	LogHopsReachedWarningInternal	Logs warning about maximum hops reached (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	LogMessage	Logs custom message to event log. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	LogMessageInternal	Logs message to the event log (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	LogMissingConnectionWarningInternal	Logs warning about missing connection (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	LogWorkflowHistory	Logs specified action in the workflow history record.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MoveDocument	Moves the document to the next step until the given condition is satisfied, returns the last step info.
	MoveDocumentInternal	Moves the document to the next step until the given condition is satisfied, returns the last step info.
	MoveStepInternal(TreeNode, WorkflowStepInfo)	Moves the specified node to the first step without automatic transition in the workflow and returns the final step.
	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 .)
	MoveToFirstStep	Moves the specified node to the first step in the workflow and returns the step.
	MoveToFirstStepInternal	Moves the specified node to the first step in the workflow and returns the step.
	MoveToNextStep	Moves the specified node to the next step in the workflow and returns new step.
	MoveToNextStepInternal	Moves the specified node to the next step in the workflow and returns new step.
	MoveToPreviousStep(TreeNode, String)	Moves the specified node to the previous step in the workflow and returns the step.
	MoveToPreviousStep(TreeNode, WorkflowStepInfo, String)	Moves the specified node to the specified previous step in the workflow and returns the step.
	MoveToPreviousStepInternal	Moves the specified node to the previous step in the workflow and returns StepID of the new step.
	MoveToPublishedStep	Automatically publishes given document. (Moves document to published step.)
	MoveToPublishedStepInternal	Moves document directly to published step. (Publishes the document without going through all the steps.)
	MoveToSpecificNextStep	Moves the specified node to the specified next step in the workflow and returns workflow step.
	MoveToSpecificStep(TreeNode, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
	MoveToSpecificStep(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
	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).)
	MoveToSpecificStepInternal(TreeNode, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, WorkflowActionEnum)	Moves the specified node to the specified step in the workflow and returns workflow step.
	MoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, WorkflowTransitionTypeEnum)	Moves the specified node to the specified step in the workflow and returns the step.
	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).)
	MoveToStepInternal(TreeNode, WorkflowStepInfo, WorkflowStepInfo, String, Boolean, WorkflowTransitionTypeEnum, Boolean)	Moves the specified node to the specified step in the workflow and returns the step.
	ProcessActionInternal	Processes action connected to given step. (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType ProcessActionInternal(WorkflowActionEventArgs InfoType, StateInfoType, ActionEnumType ).)
	ProcessActions	Processes all actions in scope. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	ProcessActionsInternal	Processes all actions in scope. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	PropagateTreeProviderInternal	Propagates tree provider
	PublishDocument	Publishes the document, returns the last step info.
	PublishDocumentInternal	Publishes the document, returns the last step info.
	SendWorkflowEmails(WorkflowEmailSettings)	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	SendWorkflowEmails(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)	Sends the workflow email for the specified document node.
	SendWorkflowEmailsInternal(WorkflowEmailSettings)	Sends the workflow e-mails to given recipients. (Inherited from AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType .)
	SendWorkflowEmailsInternal(TreeNode, UserInfo, WorkflowStepInfo, WorkflowStepInfo, WorkflowActionEnum, String)	Sends the workflow email for the specified document node.
	SetActionStatus	Sets action status
	SetActionStatusInternal	Sets action status (Overrides AbstractWorkflowManager InfoType, StateInfoType, ActionEnumType SetActionStatusInternal(InfoType, StateInfoType, String).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Extension Methods

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

Properties

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