Class CategoryCache

Cache that holds information about category. Includes deleted items.

Inheritance
object
CacheBaseV2
CategoryCache
Inherited Members
Namespace: SuperOffice.CRM.Cache
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[CacheV2(0)]
public class CategoryCache : CacheBaseV2

Constructors

CategoryCache()

Cache that holds information about category. Includes deleted items.

Declaration
public CategoryCache()

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

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()

Actual cache loading method, to be implemented by derived class. Sentry is Ignored when this method is called

Declaration
protected override void OnLoad()
Overrides

OnLoadAsync(CancellationToken)

Actual cache loading method, to be implemented by derived class. Sentry is Ignored when this method is called

Declaration
[CreateSyncVersion(OmitNullableDirective = true)]
protected override Task OnLoadAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides

Extension Methods