Class CategoryCache
Cache that holds information about category. Includes deleted items.
Inherited Members
Namespace: SuperOffice.CRM.Cache
Assembly: SoDataBase.dll
Syntax
[CacheV2("Database", 0)]
public class CategoryCache : CacheBaseV2, IFlushableV2, IDisposable
Properties
TableNames
Gets the names of the table data that are cached in this cache. When these tables are updated the cache will be disposed so a new cache instance can take its place.
Declaration
protected override IEnumerable<string> TableNames { get; }
Property Value
Type | Description |
---|---|
IEnumerable<string> |
Overrides
Methods
GetAllCategories(bool)
Return all Category records in cache
Declaration
public CategoryRecordData[] GetAllCategories(bool inclDeleted)
Parameters
Type | Name | Description |
---|---|---|
bool | inclDeleted | Do we include deleted records or not? |
Returns
Type | Description |
---|---|
CategoryRecordData[] | Array of Category record with id, value, tooltip. |
GetCategoryFromId(int)
Return a Category list name by id.
Declaration
public CategoryRecordData GetCategoryFromId(int id)
Parameters
Type | Name | Description |
---|---|---|
int | id | 123 |
Returns
Type | Description |
---|---|
CategoryRecordData | Category or NULL if no match. Item may be marked deleted. |
GetCategoryFromName(string)
Return a Category based on a name. Returns first case insensitive match.
Declaration
public CategoryRecordData GetCategoryFromName(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | "Customer" |
Returns
Type | Description |
---|---|
CategoryRecordData | Category record with id, value, tooltip. NULL if not found |
GetCurrent()
Cache that holds information about category. Includes deleted items.
Declaration
public static CategoryCache GetCurrent()
Returns
Type | Description |
---|---|
CategoryCache |
GetNameFromId(int)
Return a Category list name by id.
Declaration
public string GetNameFromId(int id)
Parameters
Type | Name | Description |
---|---|---|
int | id | 123 |
Returns
Type | Description |
---|---|
string | Category name or "" if no match. Item may be marked deleted. |
OnLoad()
Cache that holds information about category. Includes deleted items.
Declaration
protected override void OnLoad()