| WorkflowManager Methods |
The WorkflowManager type exposes the following members.
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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| CreateActionsExecutorInternal |
Creates action executor with prefilled parameters.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| EnsureStepInfo |
Ensures workflow step for given document.
|
| EnsureStepInfoInternal |
Ensures workflow step for given document.
|
| EvaluateSourcePointsInternal |
Evaluates source points with given macro resolver
(Inherited from AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| GetActionStatus |
Gets action status
|
| GetActionStatusInternal |
Gets action status
(Overrides AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetActionStatusInternal(InfoType, StateInfoType).) |
| GetBasicResolverInternal |
Gets basic resolver for evaluation of transitions and source points
(Inherited from AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEmailResolver(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetEvalResolverInternal(InfoType, StateInfoType, WorkflowInfo, WorkflowStepInfo, UserInfo).) |
| GetFirstWorkflowStep |
Returns first workflow step for given node.
|
| GetFirstWorkflowStepInternal |
Returns first workflow step for given node.
|
 | 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetNextStepInfoInternal(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepInfoInternal(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeGetPreviousStepsInternal(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 AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| GetStepTransitions(WorkflowStepInfo, WorkflowTransitionTypeEnum) |
Gets workflow step transitions
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| HandleStepTimeout |
Handles step timeout
|
| HandleStepTimeoutInternal |
Handles step timeout
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| ChangeManagerTypeOriginalType |
Changes the default manager type to the given type
(Inherited from AbstractManager.) |
| ChangeManagerTypeTo |
Changes the manager type to the given type
(Overrides AbstractManagerChangeManagerTypeTo(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| LogMessage |
Logs custom message to event log.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| LogMessageInternal |
Logs message to the event log
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| LogMissingConnectionWarningInternal |
Logs warning about missing connection
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| LogWorkflowHistory |
Logs specified action in the workflow history record.
|
| 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 AbstractWorkflowManagerInfoType, 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.
|
| MoveToPreviousSpecificStep |
Moves the specified node to the specified previous step in the workflow and returns the step.
|
| MoveToPreviousStep |
Moves the specified node to the 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToSpecificStepInternal(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeMoveToStepInternal(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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeProcessActionInternal(WorkflowActionEventArgsInfoType, StateInfoType, ActionEnumType).) |
| ProcessActions |
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumType.) |
| ProcessActionsInternal |
Processes all actions in scope.
(Inherited from AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, 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 AbstractWorkflowManagerInfoType, StateInfoType, ActionEnumTypeSetActionStatusInternal(InfoType, StateInfoType, String).) |
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.) |
See Also