Class ListCache

Inheritance

System.Object

CacheBase

ClarifyCacheBase

ListCache

Implements

IListCache

Inherited Members

ClarifyCacheBase.IsCacheOutOfDate(DateTime)

CacheBase.UpdateSyncRoot

CacheBase.OnCacheUpdated()

CacheBase.OnAnyCacheUpdated(CacheBase)

CacheBase.UpdateCache()

CacheBase.ReadCacheData(String)

CacheBase.PersistCacheData(Object, String)

CacheBase.GetCacheDataHash()

CacheBase.GenerateMD5Hash(String)

CacheBase.AllTablesExistInDataSet(DataSet, String[])

CacheBase.GetCacheFilePath(String)

CacheBase.AnyCacheUpdated

CacheBase.CacheUpdated

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: FChoice.Foundation.Clarify

Assembly: fcSDK.dll

Syntax

public class ListCache : ClarifyCacheBase, IListCache

Properties

CacheSetName

Declaration

public override string CacheSetName { get; }

Property Value

Type	Description
System.String

Overrides

CacheBase.CacheSetName

CacheType

Declaration

public override CacheType CacheType { get; }

Property Value

Type	Description
CacheType

Overrides

CacheBase.CacheType

GlobalStrings

Declaration

public IGlobalStringListCollection GlobalStrings { get; }

Property Value

Type	Description
IGlobalStringListCollection

HierarchicalStrings

Declaration

public IHierarchicalStringListCollection HierarchicalStrings { get; }

Property Value

Type	Description
IHierarchicalStringListCollection

Methods

GetGbstDefault(String)

Declaration

public string GetGbstDefault(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
System.String

GetGbstDefaultObjID(String)

Declaration

public int GetGbstDefaultObjID(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
System.Int32

GetGbstElmByID(String, Int32)

Declaration

public string GetGbstElmByID(string listTitle, int elmObjID)

Parameters

Type	Name	Description
System.String	listTitle
System.Int32	elmObjID

Returns

Type	Description
System.String

GetGbstElmObjID(String, String)

Declaration

public int GetGbstElmObjID(string listTitle, string elementTitle)

Parameters

Type	Name	Description
System.String	listTitle
System.String	elementTitle

Returns

Type	Description
System.Int32

GetGbstElmRankObjID(String, Int32)

Declaration

public int GetGbstElmRankObjID(string listTitle, int elementRank)

Parameters

Type	Name	Description
System.String	listTitle
System.Int32	elementRank

Returns

Type	Description
System.Int32

GetGbstList(String)

Declaration

public IGlobalStringList GetGbstList(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
IGlobalStringList

GetGbstListElements(String, Boolean)

Declaration

public IGlobalStringElementCollection GetGbstListElements(string listTitle, bool includeInactive)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	includeInactive

Returns

Type	Description
IGlobalStringElementCollection

GetHgbstElmDefault(String, String[])

Declaration

public string GetHgbstElmDefault(string listTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String[]	elementTitles

Returns

Type	Description
System.String

GetHgbstElmDefaultElement(String, Boolean, String[])

Declaration

public IHierarchicalStringElement GetHgbstElmDefaultElement(string listTitle, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElement

GetHgbstElmDefaultElement(String, String[])

Declaration

public IHierarchicalStringElement GetHgbstElmDefaultElement(string listTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElement

GetHgbstElmDefaultObjID(String, Boolean, String[])

Declaration

public int GetHgbstElmDefaultObjID(string listTitle, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
System.Int32

GetHgbstElmDefaultObjID(String, String[])

Declaration

public int GetHgbstElmDefaultObjID(string listTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String[]	elementTitles

Returns

Type	Description
System.Int32

GetHgbstElmObjID(String, String, Boolean, String[])

Declaration

public int GetHgbstElmObjID(string listTitle, string elementTitle, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String	elementTitle
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
System.Int32

GetHgbstElmObjID(String, String, String[])

Declaration

public int GetHgbstElmObjID(string listTitle, string elementTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String	elementTitle
System.String[]	elementTitles

Returns

Type	Description
System.Int32

GetHgbstList(String, Boolean, Boolean, String[])

Declaration

public IHierarchicalStringElementCollection GetHgbstList(string listTitle, bool includeInactive, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	includeInactive
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElementCollection

GetHgbstList(String, Boolean, String[])

Declaration

public IHierarchicalStringElementCollection GetHgbstList(string listTitle, bool includeInactive, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	includeInactive
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElementCollection

GetHgbstList(String, String[])

Declaration

public IHierarchicalStringElementCollection GetHgbstList(string listTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElementCollection

InitCacheData()

Declaration

protected override object InitCacheData()

Returns

Type	Description
System.Object

Overrides

CacheBase.InitCacheData()

IsInGbstList(String, String)

Declaration

public bool IsInGbstList(string listTitle, string element)

Parameters

Type	Name	Description
System.String	listTitle
System.String	element

Returns

Type	Description
System.Boolean

IsInHgbstList(String, String, Boolean, String[])

Declaration

public bool IsInHgbstList(string listTitle, string elementTitle, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String	elementTitle
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
System.Boolean

IsInHgbstList(String, String, String[])

Declaration

public bool IsInHgbstList(string listTitle, string elementTitle, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.String	elementTitle
System.String[]	elementTitles

Returns

Type	Description
System.Boolean

LoadCacheData(Object)

Declaration

protected override void LoadCacheData(object cacheData)

Parameters

Type	Name	Description
System.Object	cacheData

Overrides

CacheBase.LoadCacheData(Object)

RankIsInGbstList(String, Int32)

Declaration

public bool RankIsInGbstList(string listTitle, int rank)

Parameters

Type	Name	Description
System.String	listTitle
System.Int32	rank

Returns

Type	Description
System.Boolean

SetNameAndParameters(String, String)

Declaration

protected override void SetNameAndParameters(string name, string parameters)

Parameters

Type	Name	Description
System.String	name
System.String	parameters

Overrides

CacheBase.SetNameAndParameters(String, String)

TryGetHgbstList(String, Boolean, Boolean, String[])

Declaration

public IHierarchicalStringElementCollection TryGetHgbstList(string listTitle, bool throwErrors, bool includeInactive, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	throwErrors
System.Boolean	includeInactive
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElementCollection

TryGetHgbstList(String, Boolean, String[])

Declaration

public IHierarchicalStringElementCollection TryGetHgbstList(string listTitle, bool throwErrors, params string[] elementTitles)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	throwErrors
System.String[]	elementTitles

Returns

Type	Description
IHierarchicalStringElementCollection

Implements

IListCache