Class PortPrimaryCollection

Namespace
SWConfigDataClientLib.Proxies.IppbxServer
Assembly
IpPbxCDSClientLib.dll

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

[DefaultMember("Item")]
public class PortPrimaryCollection : SArrayListFacade
Inheritance
PortPrimaryCollection
Inherited Members

Constructors

PortPrimaryCollection()

standard constructor

public PortPrimaryCollection()

PortPrimaryCollection(bool) 

public PortPrimaryCollection(bool sync)

Parameters

sync bool

Fields

ClassTrace 

protected static STraceInfo ClassTrace

Field Value

STraceInfo

Properties

this[int]

Get the item per index

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

Parameters

Index int

Property Value

PortEntry

PortEntry

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

Adds the item to the collection.

public virtual void Add(PortEntry entry)

Parameters

entry PortEntry

Entry to be added.

Remarks

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

Add(PortPrimaryCollection)

Adds the item to the collection.

public virtual void Add(PortPrimaryCollection Collection)

Parameters

Collection PortPrimaryCollection

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.

ContainsEntryInLocalCollectionBySipUserID(string)

Returns true is a PortEntry with the given SIPUserID is part of the collection.

public virtual bool ContainsEntryInLocalCollectionBySipUserID(string key)

Parameters

key string

SipUserID

Returns

bool

True or False

ContainsObjectByPrimaryKey(int)

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

Element of primary key. 
public virtual bool ContainsObjectByPrimaryKey(int PortID)

Parameters

PortID int

Returns

bool

True if entry is in collection, otherwise false.

CreateSortableFilterCollection()

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

public virtual PortEntrySortableCollection CreateSortableFilterCollection()

Returns

PortEntrySortableCollection

Sortable collection with optional filter methods.

GetEntryFromLocalCollectionByName(string)

Retrieves the item with Name = key from this collection.

public virtual PortEntry GetEntryFromLocalCollectionByName(string key)

Parameters

key string

Name

Returns

PortEntry

Entry from collection

Exceptions

Exception

Will be thrown if item is not in collection.

GetEntryFromLocalCollectionBySipUserID(string)

Retrieves a PortEntry by its SIPUserID from local collection

public virtual PortEntry GetEntryFromLocalCollectionBySipUserID(string key)

Parameters

key string

SipUserID

Returns

PortEntry

The PortEntry.

GetObjectByPrimaryKey(int)

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

Primary key of item. 
public virtual PortEntry GetObjectByPrimaryKey(int PortID)

Parameters

PortID int

Returns

PortEntry

Entry

OnClear()

see base class

protected override void OnClear()

OnInsert(int, object) 

protected override void OnInsert(int index, object value)

Parameters

index int
value object

OnRemove(int, object) 

protected override void OnRemove(int index, object value)

Parameters

index int
value object

OnSet(int, object, object) 

protected override void OnSet(int index, object oldValue, object newValue)

Parameters

index int
oldValue object
newValue object

Remove(PortEntry)

Removes the item from the collection.

public virtual void Remove(PortEntry entry)

Parameters

entry PortEntry

Entry to be removed.

Remarks

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

RemoveLocally(PortEntry) 

public void RemoveLocally(PortEntry entry)

Parameters

entry PortEntry