Class PBXPhoneBookPrimaryCollection

Namespace

SWConfigDataClientLib.Proxies.UserPhoneBook

Assembly

IpPbxCDSClientLib.dll

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

[DefaultMember("Item")]
public class PBXPhoneBookPrimaryCollection : SArrayListFacade

Inheritance

object

CollectionBase

SArrayList

SArrayListFacade

PBXPhoneBookPrimaryCollection

Inherited Members

SArrayListFacade.OnRemoveComplete(int, object)

SArrayListFacade.RemoveFromLocalCollection(object)

SArrayListFacade.RemoveAll()

SArrayListFacade.RemoveFromLocalCollection(object, bool)

SArrayList.objectDictionary

SArrayList.OnClear()

SArrayList.ClearLocalCollection()

SArrayList.CurrentPos

SArrayList.RemovedObjects

Constructors

PBXPhoneBookPrimaryCollection()

standard constructor

public PBXPhoneBookPrimaryCollection()

PBXPhoneBookPrimaryCollection(bool)

public PBXPhoneBookPrimaryCollection(bool sync)

Parameters

sync bool

Fields

ClassTrace

protected static STraceInfo ClassTrace

Field Value

STraceInfo

Properties

this[int]

Get the item per index

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

Parameters

Index int

Property Value

PBXPhoneBookEntry

PBXPhoneBookEntry

ProxyNumber

protected virtual long ProxyNumber { get; }

Property Value

long

Valid

True if is valid data object

public virtual bool Valid { get; }

Property Value

bool

Methods

Add(PBXPhoneBookEntry)

Adds the item to the collection.

public virtual void Add(PBXPhoneBookEntry entry)

Parameters

entry PBXPhoneBookEntry

Entry to be added.

Remarks

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

Add(PBXPhoneBookPrimaryCollection)

Adds the item to the collection.

public virtual void Add(PBXPhoneBookPrimaryCollection Collection)

Parameters

Collection PBXPhoneBookPrimaryCollection

Remarks

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

ContainsEntryInLocalCollectionByEditableEntryID(int)

Checks is the item with EditableEntryID = key in collection.

public virtual bool ContainsEntryInLocalCollectionByEditableEntryID(int key)

Parameters

key int

EditableEntryID

Returns

bool

Returns true if collection contains item with the given key.

ContainsObjectByPrimaryKey()

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

public virtual bool ContainsObjectByPrimaryKey()

Returns

bool

True if entry is in collection, otherwise false.

CreateSortableFilterCollection()

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

public virtual PBXPhoneBookEntrySortableCollection CreateSortableFilterCollection()

Returns

PBXPhoneBookEntrySortableCollection

Sortable collection with optional filter methods.

GetEntryFromLocalCollectionByEditableEntryID(int)

Retrieves the item with EditableEntryID = key from this collection.

public virtual PBXPhoneBookEntry GetEntryFromLocalCollectionByEditableEntryID(int key)

Parameters

key int

EditableEntryID

Returns

PBXPhoneBookEntry

Entry from collection

Exceptions

Exception

Will be thrown if item is not in collection.

GetObjectByPrimaryKey()

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

public virtual PBXPhoneBookEntry GetObjectByPrimaryKey()

Returns

PBXPhoneBookEntry

Entry

Remove(PBXPhoneBookEntry)

Removes the item from the collection.

public virtual void Remove(PBXPhoneBookEntry entry)

Parameters

entry PBXPhoneBookEntry

Entry to be removed.

Remarks

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