WorkflowStepInfoProvider Class

Workflow step info provider.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<WorkflowStepInfo, WorkflowStepInfoProvider, ObjectQuery<WorkflowStepInfo>>
    CMS.DataEngine.AbstractInfoProvider<WorkflowStepInfo, WorkflowStepInfoProvider>
      CMS.WorkflowEngine.WorkflowStepInfoProvider

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 13.0.131

Syntax

public class WorkflowStepInfoProvider : AbstractInfoProvider<WorkflowStepInfo, WorkflowStepInfoProvider>, 
	IWorkflowStepInfoProvider, IInfoProvider<WorkflowStepInfo>, IInfoByIdProvider<WorkflowStepInfo>, 
	IInfoByGuidProvider<WorkflowStepInfo>

The WorkflowStepInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	WorkflowStepInfoProvider	Constructor

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CanUserApprove(UserInfo, WorkflowStepInfo, Int32)	Returns true if given user can approve or reject given step.
Public method Static member	CanUserApprove(UserInfo, WorkflowStepInfo, SourcePoint, Int32)	Returns true if given user can approve or reject given step.
Protected method	CanUserApproveInternal	Returns true if given user can approve or reject given step.
Public method Static member	CanUserManageAutomationProcesses	Indicates if user can manage automation.
Protected method	CanUserManageAutomationProcessesInternal	Indicates if user can manage automation processes.
Public method Static member	CanUserManageAutomationTemplates	Indicates if user can manage automation templates.
Protected method	CanUserManageAutomationTemplatesInternal	Indicates if user can manage automation templates.
Public method Static member	CanUserManageWorkflow	Indicates if user can manage workflow.
Protected method	CanUserManageWorkflowInternal	Indicates if user can manage workflow.
Public method Static member	CanUserMoveToSpecificAutomationStep	Indicates if user can move automation process to specific step.
Protected method	CanUserMoveToSpecificAutomationStepInternal	Indicates if user can move automation process to any step.
Public method Static member	CanUserRemoveAutomationProcess	Indicates if user can start automation process.
Protected method	CanUserRemoveAutomationProcessInternal	Indicates if user can remove automation process.
Public method Static member	CanUserStartAutomationProcess	Indicates if user can start automation process.
Protected method	CanUserStartAutomationProcessInternal	Indicates if user can start automation process.
Public method Static member	CheckDependencies	Check dependencies, return true if is depend.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ConnectSteps	Connects two steps.
Protected method	ConnectStepsInternal	Connects two steps.
Protected method	CreateDefaultApprovalSteps	Creates default approval steps for the given workflow.
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CreateDefaultWorkflowSteps	Creates default workflow steps for the given workflow.
Protected method	CreateDefaultWorkflowStepsInternal	Creates default workflow steps for the given workflow.
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteWorkflowStepInfo(Int32)	Obsolete. Deletes the specified workflow step.
Public method Static member	DeleteWorkflowStepInfo(WorkflowStepInfo)	Obsolete. Deletes the specified workflow step.
Public method Static member	DeleteWorkflowSteps	Deletes all the steps of specified workflow.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetArchivedStep	Returns the archived step for the given workflow.
Protected method	GetArchivedStepInternal	Returns the archived step for given workflow.
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetAutomationPendingStepsWhereCondition	Gets complete where condition for pending steps from automation processes.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetEditStep	Returns the edit step for the given workflow.
Protected method	GetEditStepInternal	Returns the edit step for given workflow.
Public method Static member	GetFinishedStep	Returns the finished step for the given workflow.
Protected method	GetFinishedStepInternal	Returns the finished step for given workflow.
Public method Static member	GetFirstStep	Returns first workflow step for given workflow.
Protected method	GetFirstStepInternal	Returns the first workflow step for given workflow.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetPublishedStep	Returns the published step for the given workflow.
Protected method	GetPublishedStepInternal	Returns the published step for given workflow.
Protected method	GetRequestKeyInternal	Gets key for request to store the permissions check result
Public method Static member	GetStepRoles	Returns all roles assigned to given step.
Public method Static member	GetUsersWhoCanApprove	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 method	GetUsersWhoCanApproveInternal	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 method Static member	GetWorkflowPendingStepsWhereCondition	Gets complete where condition for pending steps from workflow.
Public method Static member	GetWorkflowStepInfo(Int32)	Obsolete. Returns the WorkflowStepInfo structure for the specified workflow step ID.
Public method Static member	GetWorkflowStepInfo(String, Int32)	Returns the WorkflowStepInfo structure for the specified workflow step name and workflow.
Public method Static member	GetWorkflowStepInfoByGUID	Obsolete. Returns object with specified GUID.
Protected method	GetWorkflowStepInfoInternal	Returns the WorkflowStepInfo structure for the specified workflow step name and workflow.
Public method Static member	GetWorkflowSteps()	Obsolete. Returns the query for all workflow steps.
Public method Static member	GetWorkflowSteps(Int32)	Returns the Dataset of workflow steps.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	InitStepOrders	Initializes the workflow step orders.
Protected method	InitStepOrdersInternal	Initializes the workflow step orders.
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	MoveStepDown	Moves step down (increases its order).
Protected method	MoveStepDownInternal	Moves step down (increases its order).
Public method Static member	MoveStepUp	Moves step up (decreases its order).
Protected method	MoveStepUpInternal	Moves step up (decreases its order).
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	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 AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetWorkflowStepInfo	Obsolete. Sets the specified workflow step data.
Protected method	SetWorkflowStepInfoInternal	Obsolete. Sets the specified workflow step data.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	ValidateStepIntegrity	Checks whether selected start step and possibly source point already has a connection.
Protected method	ValidateStepIntegrityInternal	Checks whether selected start step and possibly source point already has a connection.