SettingsCategoryInfoProvider Class

Class providing Settings category management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<SettingsCategoryInfo, SettingsCategoryInfoProvider, ObjectQuery<SettingsCategoryInfo>>
    CMS.DataEngine.AbstractInfoProvider<SettingsCategoryInfo, SettingsCategoryInfoProvider>
      CMS.DataEngine.SettingsCategoryInfoProvider

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0

Syntax

public class SettingsCategoryInfoProvider : AbstractInfoProvider<SettingsCategoryInfo, SettingsCategoryInfoProvider>, 
	IRelatedObjectCountProvider

The SettingsCategoryInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SettingsCategoryInfoProvider	Constructor

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public field Static member	mRootCategory	Info object representing Settings root category.

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	RootCategory	Returns root settings category (this property is cached).
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Public method	AddSiteWhereCondition	Obsolete. Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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. (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	DeleteSettingsCategoryInfo(Int32)	Deletes specified category.
Public method Static member	DeleteSettingsCategoryInfo(SettingsCategoryInfo)	Deletes specified category.
Public method Static member	GetCategoriesOnPath	Gets all the categories on the specified category ID path in the corresponding order.
Public method Static member	GetCategoriesOnPathWhereCondition	Gets where condition for all parent categories on path except root category.
Public method Static member	GetChildSettingsCategories(Int32)	Gets DataSet with child setting categories of the specified parent setting category.
Public method Static member	GetChildSettingsCategories(String, String)	Gets DataSet with child setting categories of the specified parent setting category, filtered by where condition.
Protected method	GetChildSettingsCategoriesInternal(Int32)	Gets DataSet with child setting categories of the specified parent category.
Protected method	GetChildSettingsCategoriesInternal(String, String)	Gets DataSet with child setting categories of the specified parent category.
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>.)
Public method Static member	GetLastSettingsCategoryOrder	Returns last SettingsCategory order for specified parent SettingsCategory.
Protected method	GetLastSettingsCategoryOrderInternal	Returns last order for specified parent SettingsCategory.
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	GetRootSettingsCategoryInfo	Gets root of categories. This is distinguished by CategoryLevel = 0. If more found -> use first.
Public method Static member	GetSettingsCategories()	Gets all settings categories.
Public method Static member	GetSettingsCategories(String, String, Int32, String)	Gets all categories.
Protected method	GetSettingsCategoriesInternal	Gets all categories.
Public method Static member	GetSettingsCategoryInfo	Returns the SettingsCategoryInfo structure for the specified category.
Public method Static member	GetSettingsCategoryInfoByName	Returns the SettingsCategoryInfo structure for the name.
Protected method	GetSingleObject	Obsolete. Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	GetSiteWhereCondition	Obsolete. Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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	MoveCategoryDown	Moves specified category down.
Protected method	MoveCategoryDownInternal	Moves specified category down.
Public method Static member	MoveCategoryUp	Moves specified category up.
Protected method	MoveCategoryUpInternal	Moves specified category up.
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>.)
Public method Static member	RefreshDataCounts	Updates all counts for all sub-objects.
Protected method	RefreshDataCountsInternal	Updates all counts for all sub-objects.
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects.
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	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. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
Public method Static member	SetSettingsCategoryChildCount	Sets correct SettingsCategoryChildCount to the specified SettingsCategory.
Protected method	SetSettingsCategoryChildCountInternal	Sets correct CategoryChildCount to the specified SettingsCategory.
Public method Static member	SetSettingsCategoryInfo	Sets (updates or inserts) specified category.
Public method	SortAlphabetically	Obsolete. Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
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>.)