The CategoryInfoProvider type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
| Name | Description | |
|---|---|---|
 | CategoryInfoProvider |
Constructor
|
Methods
| Name | Description | |
|---|---|---|
| AddSiteWhereCondition(String, Int32, String, Boolean) |
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| AddSiteWhereCondition(String, Int32, String, Boolean, String) |
Creates site where condition from the specified parameters and adds it to the original where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
 | BoundGetInfoByGuid(Guid) |
Gets the info object by its GUID
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| BoundGetInfoByGuid(Guid, Int32) |
Gets the info object by its GUID and site ID
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| BoundGetInfoById |
Gets the info by ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| BoundGetInfoByName(String) |
Gets the info object by its code name
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| BoundGetInfoByName(String, Int32) |
Gets the info object by its code name and site Id
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| BoundGetInfosByIds |
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
 | Clear |
Clears hash tables.
|
| ClearHashtables |
Clear hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| CreateInfo(Int32) |
Creates an instance of info object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| CreateInfo(DataRow, Boolean) |
Creates a new info object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| CreateWebFarmTask(String, String) |
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.) |
| CreateWebFarmTask(String, String, Byte ) |
Creates web farm task specific for current object and action name
(Inherited from AbstractProvider.) |
| DeleteCategoryInfo(Int32) |
Deletes category with specified ID.
|
| DeleteCategoryInfo(CategoryInfo) |
Deletes specified category.
|
| DeleteCategoryInfoInternal |
Deletes specified category.
|
| DeleteData(String) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| DeleteData(IWhereCondition) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| DeleteData(Action ObjectQuery TInfo ) |
Deletes the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| DeleteInfo |
Deletes the object to the database.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| DeleteObjectFromHashtables |
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
|  Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetBindingWhereCondition(String, Int32) |
Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetBindingWhereCondition(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 AbstractInfoProvider TInfo, TProvider .) |
| GetCacheDependency(DataSet, String, String) |
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetCacheDependency(BaseInfo, String, String) |
Gets the cache dependency for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetCategories |
Returns a query for all the categoryInfo objects.
|
| GetCategories(String, String, Int32, String) |
Returns a query for all categories matching the specified parameters.
|
| GetCategories(String, String, Int32, String, Int32) |
Returns a query for all categories for specified site matching the specified parameters.
|
| GetCategoriesInternal |
Returns a query for all the categoryInfo objects.
|
| GetCategoryCount |
Gets count of the documents related to the specified category.
|
| GetCategoryCountInternal |
Gets count of the documents related to the specified category.
|
| GetCategoryDocumentsWhereCondition |
Returns where condition usable for filtering documents by category.
|
| GetCategoryDocumentsWhereConditionInternal |
Returns where condition usable for filtering documents by category.
|
| GetCategoryInfo(Int32) |
Returns category with specified ID.
|
| GetCategoryInfo(String, String) |
Returns category with specified name.
|
| GetCategoryInfoInternal(Int32) |
Returns category with specified ID.
|
| GetCategoryInfoInternal(String, String) |
Returns category with specified name.
|
| GetCountInternal |
Gets the number of items matching the given parameters. Does not check the license when retrieving data.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32) |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32 , Int32) |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDataByColumn T |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDataByGuidColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDataByIntColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDataByStringColumn |
Returns the data according to the set of input parameters.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDeleteQuery |
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDependencyCacheKeys(DataSet, String, String) |
Gets the cache dependency keys for the given DataSet.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDependencyCacheKeys(GeneralizedInfo, String, String) |
Gets the cache dependency keys for the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetDocumentCategories(String, String, Int32) |
Returns dataset of all categories base on complete where condition from TreeProvider.
|
| GetDocumentCategories(Int32, String, String, Int32, String) |
Returns all categories the document is a member of.
|
| GetDocumentCategoriesInternal(String, String, Int32) |
Returns dataset of all categories base on complete where condition from TreeProvider.
|
| GetDocumentCategoriesInternal(Int32, String, String, Int32, String) |
Returns all categories the document is a member of.
|
| GetEmptyDataSet |
Gets the empty data set to be filled by the data
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetFullNameDictionary |
Creates new dictionary for caching the objects by full name
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetFullNameWhereCondition |
Gets the where condition that searches the object based on the given full name
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetChildCategories |
Returns a query for all subcategories for specified site matching the specified parameters.
|
| GetInfo(IWhereCondition) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfo(Action ObjectQuery TInfo ) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfo(String, String) |
Gets an instance of the first info object matching the specified condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Int32) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Int32, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Int32, Int32) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Int32, Boolean, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeName(String, Int32, Int32, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByCodeNameFromDB |
Gets an instance of info object based on the given code name from database
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByFullName(String) |
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByFullName(String, Boolean) |
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByFullNameInternal |
Gets the info by its full name from the database
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuid(Guid) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuid(Guid, Boolean) |
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuid(Guid, Int32) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuid(Guid, Int32, Boolean) |
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuidColumn |
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByGuidFromDB |
Gets an instance of info object based on the given GUID from database
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoById(Int32) |
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoById(Int32, Boolean) |
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByIntColumn |
Gets an instance of info object based on the integer column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfoByStringColumn |
Gets an instance of info object based on the string column value.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetInfosByIds |
Gets the list of info objects by their IDs
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetLastCategoryOrder |
Returns maximum order value for given category siblings.
|
| GetLastCategoryOrderInternal |
Returns maximum order value for given category siblings.
|
| GetObjectQuery |
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetObjectQueryInternal |
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetParentWhereCondition |
Gets the where condition to limit the objects to specific parent.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetSingleObject |
Gets the object query for the provider
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetSiteWhereCondition(Int32) |
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetSiteWhereCondition(Int32, Boolean) |
Gets the where condition to limit the objects to specific site.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| GetType | Gets the (Inherited from Type of the current instance.Object.) |
| GetTypeInfo |
Gets the type info for this provider
(Inherited from BaseAbstractInfoProvider.) |
| CheckUniqueCodeName |
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| 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 .) |
| Init |
Initializes the provider variables.
(Inherited from BaseAbstractInfoProvider.) |
| InitHashtables |
Initializes the hashtable settings
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| Invalidate |
Sets this provider as invalid
(Inherited from AbstractProvider.) |
| LoadAllInfos |
Loads all infos to the hashtable
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| LoadGeneration |
Loads the specified generation of the objects.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| LoadInfos |
Loads all objects from the database to memory.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| LoadObjectsToHashtables |
Loads the objects from a DataSet to the hashtables
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| MemberwiseClone | Creates a shallow copy of the current (Inherited from Object.Object.) |
| MoveCategoryDown |
Moves specified category down within the parent category.
|
| MoveCategoryDownInternal |
Moves specified category down within the parent category.
|
| MoveCategoryUp |
Moves specified category up within the parent category.
|
| MoveCategoryUpInternal |
Moves specified category up within the parent category.
|
| NewTransaction |
Creates a new transaction over this provider
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| ProcessWebFarmTask |
Runs the processing of specific web farm task for current provider
(Inherited from BaseAbstractInfoProvider.) |
| RecalculateData |
Recalculates the value in the given column using the coefficient.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| RefreshObjectsCounts |
Updates all counts for all sub-objects.
(Inherited from BaseAbstractInfoProvider.) |
| Register |
Initializes the provider variables.
(Inherited from AbstractProvider.) |
| RegisterObjectInHashtables |
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| RemoveOriginalCodeNameFromHashtable |
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| ReplaceData |
Replaces the data in the given columns.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| ResetToDefault |
Resets the provider to default implementation
(Inherited from AbstractInfoProvider TProvider .) |
| SetAsDefaultProvider |
Sets this provider instance as the default provider
(Inherited from AbstractInfoProvider TProvider .) |
| SetCategoryInfo |
Sets (updates or inserts) specified category.
|
| SetCategoryInfoInternal |
Sets (updates or inserts) specified category.
|
| SetInfo |
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| SortAlphabetically |
Sorts the object alphabetically.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TouchCacheDependencies |
Touches the cache dependencies of the given object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UpdateData |
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UpdateObjectInHashtables |
Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseSource( TInfo ) |
Sets the provider to use given data as data source
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseSource(DataQuerySource) |
Sets the provider to use given data as data source
(Inherited from BaseAbstractInfoProvider.) |
| ValidateCodeName |
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
Extension Methods
| Name | Description | |
|---|---|---|
 | GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) |
| ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) |
| ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Fields
| Name | Description | |
|---|---|---|
 | infos |
Info tables.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| mTypeInfo |
Object type information.
(Inherited from BaseAbstractInfoProvider.) |
Properties
| Name | Description | |
|---|---|---|
 | CategoryIDLength |
Length of the category ID, 8 by default.
|
 | DataSource |
Data source for the provider
(Inherited from BaseAbstractInfoProvider.) |
| GenerationColumn |
Column used to filter the data according the generation in which the items should be loaded.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| InfoObject |
Info object instance the provider is working with.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| InfoType |
Returns the type of the info object for this provider
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| IsDataAvailable |
Returns true if the data is available for this provider
(Inherited from BaseAbstractInfoProvider.) |
| IsValid |
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractProvider.) |
| LoadHashtables |
Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| MaxCategoryLevel |
Returns maximal available level of the category.
|
| ProviderName |
Provider name
(Inherited from BaseAbstractInfoProvider.) |
| StoreEmptyValuesInHashtables |
If true, provider hashtables store empty values for not found objects to reduce database calls
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| TypeInfo |
Object type information.
(Inherited from BaseAbstractInfoProvider.) |
| UseFullNameHashtable |
If true, the full name hashtable is allowed to be used.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseGuidHashtable |
If true, the guid hashtable is allowed to be used.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseHashtables |
If true, the provider uses hashtables.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseIDHashtable |
If true, the ID hashtable is allowed to be used.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseNameHashtable |
If true, the code name hashtable is allowed to be used.
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
| UseWeakReferences |
If true, the weak references are used for the items so the memory can be cleared upon request
(Inherited from AbstractInfoProvider TInfo, TProvider .) |
See Also