StagingTaskInfoProvider Class

Class providing TaskInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<StagingTaskInfo, StagingTaskInfoProvider, ObjectQuery<StagingTaskInfo>>
    CMS.DataEngine.AbstractInfoProvider<StagingTaskInfo, StagingTaskInfoProvider>
      CMS.Synchronization.StagingTaskInfoProvider

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 12.0.0

Syntax

public class StagingTaskInfoProvider : AbstractInfoProvider<StagingTaskInfo, StagingTaskInfoProvider>

The StagingTaskInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	StagingTaskInfoProvider

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	KeepOlderTasks	Indicates if older tasks should be kept.
Public field Static member	LOGCONTEXT_SYNCHRONIZATION	Context name for AsyncControl log filtering to synchronization API calls only.
Public field Static member	LogGlobalObjectsOnlyForAssignedSites	If true, tasks for global objects are logged only for the sites assigned to the object.
Public field Static member	ServerName	Current server name.
Public field Static member	StagingEnabled	Indicates whether staging is enabled globally based on AppSettings value. It is enabled by default.

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 Static member	ObjectTree	Object tree.
Public property Static member	TaskServerList	Task server list.
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	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>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteOlderTasks	Deletes older synchronization tasks.
Protected method	DeleteOlderTasksInternal(StagingTaskInfo)	Deletes older synchronization tasks of same object.
Protected method	DeleteOlderTasksInternal(StagingTaskInfo, WhereCondition)	Deletes older synchronization tasks of same object.
Public method Static member	DeleteOrphanedTasks	Deletes old orphaned tasks.
Protected method	DeleteOrphanedTasksInternal	Deletes old orphaned tasks.
Public method Static member	DeleteRedundantTasks	Deletes synchronization tasks without any binding to a server (i.e. there is no record in Staging_Synchronization table for such task).
Protected method	DeleteRedundantTasksInternal	Deletes synchronization tasks without any binding to a server (i.e. there is no record in Staging_Synchronization table for such task).
Public method Static member	DeleteTaskInfo(Int32)	Deletes specified task.
Public method Static member	DeleteTaskInfo(StagingTaskInfo)	Deletes specified task.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	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	GetInfoById	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	GetServerIdsToLogTaskTo	Gets the list of server IDs for which the staging task should be logged.
Protected method	GetServerIdsToLogTaskToInternal	Gets the list of server IDs for which the staging task should be logged.
Public method Static member	GetTaskInfo	Returns the TaskInfo structure for the specified task.
Public method Static member	GetTasks()	Get all staging tasks.
Public method Static member	GetTasks(String, String, Boolean, Int32, String)	Returns query with all tasks filtered by where condition.
Public method Static member	GetTasksForSynchronization	Returns all the tasks that need to be synchronized (including older tasks that needs to be processed before the tasks with given IDs).
Protected method	GetTasksForSynchronizationInternal	Returns all the tasks that need to be synchronized (including older tasks that needs to be processed before the tasks with given IDs).
Protected method	GetTasksInternal	Returns dataset of all tasks filtered by where condition.
Public method Static member	GetTaskTitle	Gets task title.
Protected method	GetTaskTitleInternal	Gets task title.
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>.)
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	LogContentChanges	Indicates if logging staging tasks for content is enabled.
Public method Static member	LogDataChanges	Indicates if logging data changes is enabled.
Public method Static member	LoggingOfStagingTasksEnabled	Returns true if settings for logging staging task are enabled for given site. If site is String.Empty, then value is returned for global keys.
Public method Static member	LogObjectChanges	Indicates if logging object changes staging tasks is enabled.
Protected method	LogSynchronizationInternal	Logs the synchronization task for the given object.
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 Static member	SelectDocumentTaskList(Int32, Int32, String, String, String, Int32, String, Int32, Int32)	Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data.
Public method Static member	SelectDocumentTaskList(Int32, Int32, String, String, String, Int32, String, Int32, Int32, Int32)	Obsolete. Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data.
Public method Static member	SelectObjectTaskList(Int32, Int32, String, String, String, Int32, String, Int32, Int32)	Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data.
Public method Static member	SelectObjectTaskList(Int32, Int32, String, String, String, Int32, String, Int32, Int32, Int32)	Obsolete. Selects all the tasks within subtree of given alias path, with information on the count of the failed attempts and without the task data.
Public method Static member	SelectTaskList(Int32, Int32, String, String, Int32, String, Int32, Int32)	Selects all the tasks with information on the count of the failed attempts and without the task data.
Public method Static member	SelectTaskList(Int32, Int32, String, String, Int32, String, Int32, Int32, Int32)	Obsolete. Selects all the tasks with information on the count of the failed attempts and without the task data.
Protected method	SelectTaskListInternal(Int32, Int32, String, String, Int32, String, Int32, Int32)	Selects all the tasks with information on the count of the failed attempts and without the task data.
Protected method	SelectTaskListInternal(Int32, Int32, String, String, Int32, String, Int32, Int32, Int32)	Obsolete. Selects all the tasks with information on the count of the failed attempts and without the task data.
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (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	SetTaskInfo	Sets (updates or inserts) specified task.
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 Static member	UpdateTaskServers	Updates the task servers with the current server name
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)