Click or drag to resize
WorkflowStepInfoProvider Class
Workflow step info provider.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderWorkflowStepInfo, WorkflowStepInfoProvider, ObjectQueryWorkflowStepInfo
    CMS.DataEngineAbstractInfoProviderWorkflowStepInfo, WorkflowStepInfoProvider
      CMS.WorkflowEngineWorkflowStepInfoProvider

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 13.0.131
Syntax
C#
public class WorkflowStepInfoProvider : AbstractInfoProvider<WorkflowStepInfo, WorkflowStepInfoProvider>, 
	IWorkflowStepInfoProvider, IInfoProvider<WorkflowStepInfo>, IInfoByIdProvider<WorkflowStepInfo>, 
	IInfoByGuidProvider<WorkflowStepInfo>

The WorkflowStepInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowStepInfoProvider
Constructor
Top
Fields
Properties
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCanUserApprove(UserInfo, WorkflowStepInfo, Int32)
Returns true if given user can approve or reject given step.
Public methodStatic memberCanUserApprove(UserInfo, WorkflowStepInfo, SourcePoint, Int32)
Returns true if given user can approve or reject given step.
Protected methodCanUserApproveInternal
Returns true if given user can approve or reject given step.
Public methodStatic memberCanUserManageAutomationProcesses
Indicates if user can manage automation.
Protected methodCanUserManageAutomationProcessesInternal
Indicates if user can manage automation processes.
Public methodStatic memberCanUserManageAutomationTemplates
Indicates if user can manage automation templates.
Protected methodCanUserManageAutomationTemplatesInternal
Indicates if user can manage automation templates.
Public methodStatic memberCanUserManageWorkflow
Indicates if user can manage workflow.
Protected methodCanUserManageWorkflowInternal
Indicates if user can manage workflow.
Public methodStatic memberCanUserMoveToSpecificAutomationStep
Indicates if user can move automation process to specific step.
Protected methodCanUserMoveToSpecificAutomationStepInternal
Indicates if user can move automation process to any step.
Public methodStatic memberCanUserRemoveAutomationProcess
Indicates if user can start automation process.
Protected methodCanUserRemoveAutomationProcessInternal
Indicates if user can remove automation process.
Public methodStatic memberCanUserStartAutomationProcess
Indicates if user can start automation process.
Protected methodCanUserStartAutomationProcessInternal
Indicates if user can start automation process.
Public methodStatic memberCheckDependencies
Check dependencies, return true if is depend.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clears the object's hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberConnectSteps
Connects two steps.
Protected methodConnectStepsInternal
Connects two steps.
Protected methodCreateDefaultApprovalSteps
Creates default approval steps for the given workflow.
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberCreateDefaultWorkflowSteps
Creates default workflow steps for the given workflow.
Protected methodCreateDefaultWorkflowStepsInternal
Creates default workflow steps for the given workflow.
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteWorkflowStepInfo(Int32) Obsolete.
Deletes the specified workflow step.
Public methodStatic memberDeleteWorkflowStepInfo(WorkflowStepInfo) Obsolete.
Deletes the specified workflow step.
Public methodStatic memberDeleteWorkflowSteps
Deletes all the steps of specified workflow.
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetArchivedStep
Returns the archived step for the given workflow.
Protected methodGetArchivedStepInternal
Returns the archived step for given workflow.
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetAutomationPendingStepsWhereCondition
Gets complete where condition for pending steps from automation processes.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetEditStep
Returns the edit step for the given workflow.
Protected methodGetEditStepInternal
Returns the edit step for given workflow.
Public methodStatic memberGetFinishedStep
Returns the finished step for the given workflow.
Protected methodGetFinishedStepInternal
Returns the finished step for given workflow.
Public methodStatic memberGetFirstStep
Returns first workflow step for given workflow.
Protected methodGetFirstStepInternal
Returns the first workflow step for given workflow.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetPublishedStep
Returns the published step for the given workflow.
Protected methodGetPublishedStepInternal
Returns the published step for given workflow.
Protected methodGetRequestKeyInternal
Gets key for request to store the permissions check result
Public methodStatic memberGetStepRoles
Returns all roles assigned to given step.
Public methodStatic memberGetUsersWhoCanApprove
Returns list of users who can approve given step source point. Users who are approved due to generic roles are not included to the result.
Protected methodGetUsersWhoCanApproveInternal
Returns list of users who can approve given step and source point. Users who are approved due to generic roles are not included to the result.
Public methodStatic memberGetWorkflowPendingStepsWhereCondition
Gets complete where condition for pending steps from workflow.
Public methodStatic memberGetWorkflowStepInfo(Int32) Obsolete.
Returns the WorkflowStepInfo structure for the specified workflow step ID.
Public methodStatic memberGetWorkflowStepInfo(String, Int32)
Returns the WorkflowStepInfo structure for the specified workflow step name and workflow.
Public methodStatic memberGetWorkflowStepInfoByGUID Obsolete.
Returns object with specified GUID.
Protected methodGetWorkflowStepInfoInternal
Returns the WorkflowStepInfo structure for the specified workflow step name and workflow.
Public methodStatic memberGetWorkflowSteps Obsolete.
Returns the query for all workflow steps.
Public methodStatic memberGetWorkflowSteps(Int32)
Returns the Dataset of workflow steps.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberInitStepOrders
Initializes the workflow step orders.
Protected methodInitStepOrdersInternal
Initializes the workflow step orders.
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberMoveStepDown
Moves step down (increases its order).
Protected methodMoveStepDownInternal
Moves step down (increases its order).
Public methodStatic memberMoveStepUp
Moves step up (decreases its order).
Protected methodMoveStepUpInternal
Moves step up (decreases its order).
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodSet
Inserts or updates the info object in the underlying data store.
(Overrides AbstractInfoProviderTInfo, TProviderSet(TInfo).)
Public methodSetAsDefaultProvider

Sets this provider instance as the default provider.

Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization).

(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetWorkflowStepInfo Obsolete.
Sets the specified workflow step data.
Protected methodSetWorkflowStepInfoInternal Obsolete.
Sets the specified workflow step data.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberValidateStepIntegrity
Checks whether selected start step and possibly source point already has a connection.
Protected methodValidateStepIntegrityInternal
Checks whether selected start step and possibly source point already has a connection.
Top
See Also