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

Namespace: CMS.WorkflowEngine
Assembly: CMS.WorkflowEngine (in CMS.WorkflowEngine.dll) Version: 10.0.0
Syntax
C#
public class WorkflowStepInfoProvider : AbstractInfoProvider<WorkflowStepInfo, WorkflowStepInfoProvider>

The WorkflowStepInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodWorkflowStepInfoProvider
Constructor
Top
Fields
  NameDescription
Protected fieldhashtableLock
Table lock for loading hashtables
(Inherited from BaseAbstractInfoProvider.)
Protected fieldinfos
Info tables.
(Inherited from BaseAbstractInfoProvider.)
Top
Properties
  NameDescription
Protected propertyDataSource
Data source for the provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from BaseAbstractInfoProvider.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyInfoType
Returns the type of the info object for this provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsDataAvailable
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.)
Protected propertyProviderName
Provider name
(Inherited from BaseAbstractInfoProvider.)
Public propertyTypeInfo
Object type information.
(Inherited from BaseAbstractInfoProvider.)
Top
Methods
  NameDescription
Public methodAddSiteWhereCondition(String, Int32, String, Boolean)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodAddSiteWhereCondition(String, Int32, String, Boolean, String)
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodApplySourceTQuery
If the provider has a data source specified, applies this source to the given query. Returns the modified query.
(Inherited from BaseAbstractInfoProvider.)
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByFullName
Gets the info object by its full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByGuid(Guid)
Gets the info object by its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByGuid(Guid, Int32)
Gets the info object by its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoById
Gets the info by ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String)
Gets the info object by its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfoByName(String, Int32)
Gets the info object by its code name and site Id.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodBoundGetInfosByIds
Gets the list of info objects by their IDs.
(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 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 memberClear Obsolete.
Clear hashtables.
Protected methodClearHashtables
Clear 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 methodCreateHashtables
Creates the provider hashtables
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(Int32)
Creates an instance of info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo(DataRow, Boolean)
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 AbstractProvider.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.)
Protected methodDeleteData(String) Obsolete.
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteData(IWhereCondition) Obsolete.
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Removes the object instance from the hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteObjectFromHashtables(TInfo).)
Public methodStatic memberDeleteWorkflowStepInfo(Int32)
Deletes the specified workflow step.
Public methodStatic memberDeleteWorkflowStepInfo(WorkflowStepInfo)
Deletes the specified workflow step.
Protected methodDeleteWorkflowStepInfoInternal
Deletes the specified workflow step.
Public methodStatic memberDeleteWorkflowSteps
Deletes all the steps of specified workflow.
Public methodStatic memberGetArchivedStep
Returns the archived step for the given workflow.
Protected methodGetArchivedStepInternal
Returns the archived step for given workflow.
Public methodStatic memberGetAutomationPendingStepsWhereCondition
Gets complete where condition for pending steps from automation processes.
Public methodGetBindingWhereCondition(String, Int32)
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetBindingWhereCondition(String, Object)
Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCacheDependency(DataSet, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCacheDependency(BaseInfo, String, String)
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCountInternal
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetCurrentProvider
Gets the current provider instance
(Inherited from AbstractInfoProviderTProvider.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByColumnT
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByGuidColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByIntColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDataByStringColumn Obsolete.
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(DataSet, String, String)
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetDependencyCacheKeys(GeneralizedInfo, String, String)
Gets collection of dependency keys to be touched when modifying the current object.
(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.
Protected methodGetEmptyDataSet
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetExistingIDsInternal Obsolete.
Filters out all object IDs that do not exist in the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodGetFullNameDictionary
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetFullNameWhereCondition
Gets the where condition that searches the object based on the given full name.
(Inherited from BaseAbstractInfoProvider.)
Protected methodGetGeneralObjectQuery
Gets an object query from the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(ActionTQuery)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(IWhereCondition)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfo(String, String)
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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 methodGetInfoByColumnT
Gets an instance of info object based on the column value.
(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 methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIntColumn Obsolete.
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByStringColumn Obsolete.
Gets an instance of info object based on the string column value.
(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 methodGetParentWhereCondition
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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
Protected methodGetSingleObject
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGetSiteWhereCondition
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetStepRoles
Returns the DataSet of roles assigned to given step.
Protected methodGetTypeInfo
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.)
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)
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
Returns object with specified GUID.
Protected methodGetWorkflowStepInfoInternal(Guid)
Returns object with specified GUID.
Protected methodGetWorkflowStepInfoInternal(Int32)
Returns the WorkflowStepInfo structure for the specified workflow step ID.
Protected methodGetWorkflowStepInfoInternal(String, Int32)
Returns the WorkflowStepInfo structure for the specified workflow step name and workflow from database.
Protected methodGetWorkflowStepInfoInternal(String, Int32, Boolean)
Returns the WorkflowStepInfo structure for the specified workflow step name and workflow.
Public methodStatic memberGetWorkflowSteps
Returns the query for all workflow steps.
Public methodStatic memberGetWorkflowSteps(Int32)
Returns the Dataset of workflow steps.
Protected methodGetWorkflowStepsInternal
Returns the query for all workflow steps.
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 methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtables Obsolete.
Initializes the hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from BaseAbstractInfoProvider.)
Public methodStatic memberInitStepOrders
Initializes the workflow step orders.
Protected methodInitStepOrdersInternal
Initializes the workflow step orders.
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.)
Protected methodInvalidate
Sets this provider as invalid
(Inherited from AbstractProvider.)
Public methodStatic memberLicenseVersionCheck
Checks if WorkFlowStep fulfill license limitations.
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 methodNewTransaction Obsolete.
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.)
Public methodRefreshObjectsCounts
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.)
Protected methodRegister
Registers current provider in providers collection
(Inherited from AbstractProvider.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryRegisterObjectInHashtables(TInfo).)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodResetToDefault
Resets the provider to default implementation
(Inherited from AbstractInfoProviderTProvider.)
Public methodSetAsDefaultProvider
Sets this provider instance as the default provider
(Inherited from AbstractInfoProviderTProvider.)
Protected methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetWorkflowStepInfo
Sets the specified workflow step data.
Protected methodSetWorkflowStepInfoInternal
Sets the specified workflow step data.
Public methodSortAlphabetically
Sorts the object alphabetically.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodTouchCacheDependencies
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
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.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryUpdateObjectInHashtables(TInfo).)
Public methodUseSource(TInfo) Obsolete.
Sets the provider to use given data as data source
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodUseSource(DataQuerySource) Obsolete.
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.)
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