Class LocationPrimaryCollection

Namespace

SWConfigDataClientLib.Proxies.Locations

Assembly

IpPbxCDSClientLib.dll

Collection of primary configuration items. The primary configuration item is LocationEntry. This class is generated.

[DefaultMember("Item")]
public class LocationPrimaryCollection : SArrayList

Inheritance

object

CollectionBase

SArrayList

LocationPrimaryCollection

Inherited Members

SArrayList.objectDictionary

SArrayList.OnClear()

SArrayList.ClearLocalCollection()

SArrayList.OnRemoveComplete(int, object)

SArrayList.RemoveAll()

SArrayList.RemoveFromLocalCollection(object)

SArrayList.RemoveFromLocalCollection(object, bool)

SArrayList.CurrentPos

SArrayList.RemovedObjects

Remarks

Thread Safety: safe

Constructors

LocationPrimaryCollection()

standard constructor

public LocationPrimaryCollection()

Fields

ClassTrace

protected static STraceInfo ClassTrace

Field Value

STraceInfo

Properties

this[int]

Get the item per index

public virtual LocationEntry this[int Index] { get; set; }

Parameters

Index int

Property Value

LocationEntry

LocationEntryBase

Remarks

Thread Safety: safe

ProxyNumber

protected virtual long ProxyNumber { get; }

Property Value

long

Valid

True if is valid data object

public virtual bool Valid { get; }

Property Value

bool

Remarks

Thread Safety: safe

Methods

Add(LocationEntry)

Adds the item to the collection.

public virtual void Add(LocationEntry entry)

Parameters

entry LocationEntry

Entry to be added.

Remarks

The item will not be stored in database directly. To effect the database use the method update() of LocationEnum.

Add(LocationPrimaryCollection)

Adds the item to the collection.

public virtual void Add(LocationPrimaryCollection Collection)

Parameters

Collection LocationPrimaryCollection

Remarks

The item will not be stored in database. To effect the database use members of .

ContainsEntryInLocalCollectionByName(string)

Checks is the item with Name = key in collection.

public virtual bool ContainsEntryInLocalCollectionByName(string key)

Parameters

key string

Name

Returns

bool

Returns true if collection contains item with the given key.

Remarks

Thread Safety: safe

ContainsObjectByPrimaryKey(int)

Checks if the item, identified by the primary key, is in this collection.

Element of primary key.

public virtual bool ContainsObjectByPrimaryKey(int LocationID)

Parameters

LocationID int

Returns

bool

True if entry is in collection, otherwise false.

Remarks

Thread Safety: safe

CreateSortableFilterCollection()

Creates a sortable collection containing all current entries of this collection.

public virtual LocationEntrySortableCollection CreateSortableFilterCollection()

Returns

LocationEntrySortableCollection

Sortable collection with optional filter methods.

Remarks

Thread Safety: safe

GetEntryFromLocalCollectionByName(string)

Retrieves the item with Name = key from this collection.

public virtual LocationEntry GetEntryFromLocalCollectionByName(string key)

Parameters

key string

Name

Returns

LocationEntry

Entry from collection

Remarks

Thread Safety: safe

Exceptions

Exception

Will be thrown if item is not in collection.

GetObjectByPrimaryKey(int)

Gets the item identified by the primary key from this collection.

Primary key of item.

public virtual LocationEntry GetObjectByPrimaryKey(int LocationID)

Parameters

LocationID int

Returns

LocationEntry

Entry

Remarks

Thread Safety: safe

Remove(LocationEntry)

Removes the item from the collection.

public virtual void Remove(LocationEntry entry)

Parameters

entry LocationEntry

Entry to be removed.

Remarks

The item will not be deleted in database directly. To effect the database use update(true) of .