Interface IListCache

Namespace: FChoice.Foundation.Clarify

Assembly: fcSDK.dll

Syntax

public interface IListCache

Properties

CacheSetName

Declaration

string CacheSetName { get; }

Property Value

Type	Description
System.String

CacheType

Declaration

CacheType CacheType { get; }

Property Value

Type	Description
CacheType

GlobalStrings

Declaration

IGlobalStringListCollection GlobalStrings { get; }

Property Value

Type	Description
IGlobalStringListCollection

HierarchicalStrings

Declaration

IHierarchicalStringListCollection HierarchicalStrings { get; }

Property Value

Type	Description
IHierarchicalStringListCollection

Methods

GetGbstDefault(String)

Declaration

string GetGbstDefault(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
System.String

GetGbstDefaultObjID(String)

Declaration

int GetGbstDefaultObjID(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
System.Int32

GetGbstElmByID(String, Int32)

Declaration

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

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

int GetGbstElmRankObjID(string listTitle, int elementRank)

Parameters

Type	Name	Description
System.String	listTitle
System.Int32	elementRank

Returns

Type	Description
System.Int32

GetGbstList(String)

Declaration

IGlobalStringList GetGbstList(string listTitle)

Parameters

Type	Name	Description
System.String	listTitle

Returns

Type	Description
IGlobalStringList

GetGbstListElements(String, Boolean)

Declaration

IGlobalStringElementCollection GetGbstListElements(string listTitle, bool includeInactive)

Parameters

Type	Name	Description
System.String	listTitle
System.Boolean	includeInactive

Returns

Type	Description
IGlobalStringElementCollection

GetHgbstElmDefault(String, String[])

Declaration

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

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

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

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

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

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

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

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

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

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

Parameters

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

Returns

Type	Description
IHierarchicalStringElementCollection

IsInGbstList(String, String)

Declaration

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

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

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

RankIsInGbstList(String, Int32)

Declaration

bool RankIsInGbstList(string listTitle, int rank)

Parameters

Type	Name	Description
System.String	listTitle
System.Int32	rank

Returns

Type	Description
System.Boolean

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

Declaration

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

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

UpdateCache()

Declaration

void UpdateCache()

Events

CacheUpdated

Declaration

event EventHandler CacheUpdated

Event Type

Type	Description
System.EventHandler