Class UserPrimaryCollection

Namespace

SWConfigDataClientLib.Proxies.Users

Assembly

IpPbxCDSClientLib.dll

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

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

Inheritance

object

CollectionBase

SArrayList

UserPrimaryCollection

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

UserPrimaryCollection()

standard constructor

public UserPrimaryCollection()

Fields

ClassTrace

protected static STraceInfo ClassTrace

Field Value

STraceInfo

Properties

this[int]

Get the item per index

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

Parameters

Index int

Property Value

UserEntry

UserEntryBase

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

Adds the item to the collection.

public virtual void Add(UserEntry entry)

Parameters

entry UserEntry

Entry to be added.

Remarks

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

Add(UserPrimaryCollection)

Adds the item to the collection.

public virtual void Add(UserPrimaryCollection Collection)

Parameters

Collection UserPrimaryCollection

Remarks

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

ContainsEntryInLocalCollectionByAutoLoginPhone(string)

Checks is the item with AutoLoginPhone = key in collection.

public virtual bool ContainsEntryInLocalCollectionByAutoLoginPhone(string key)

Parameters

key string

AutoLoginPhone

Returns

bool

Returns true if collection contains item with the given key.

Remarks

Thread Safety: safe

ContainsEntryInLocalCollectionByH323Alias(string)

Checks is the item with H323Alias = key in collection.

public virtual bool ContainsEntryInLocalCollectionByH323Alias(string key)

Parameters

key string

H323Alias

Returns

bool

Returns true if collection contains item with the given key.

Remarks

Thread Safety: safe

ContainsEntryInLocalCollectionByLanPhonePin(string)

Checks is the item with LanPhonePin = key in collection.

public virtual bool ContainsEntryInLocalCollectionByLanPhonePin(string key)

Parameters

key string

LanPhonePin

Returns

bool

Returns true if collection contains item with the given key.

Remarks

Thread Safety: safe

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 UserID)

Parameters

UserID 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 UserEntrySortableCollection CreateSortableFilterCollection()

Returns

UserEntrySortableCollection

Sortable collection with optional filter methods.

Remarks

Thread Safety: safe

GetEntryFromLocalCollectionByAutoLoginPhone(string)

Retrieves the item with AutoLoginPhone = key from this collection.

public virtual UserEntry GetEntryFromLocalCollectionByAutoLoginPhone(string key)

Parameters

key string

AutoLoginPhone

Returns

UserEntry

Entry from collection

Remarks

Thread Safety: safe

Exceptions

Exception

Will be thrown if item is not in collection.

GetEntryFromLocalCollectionByH323Alias(string)

Retrieves the item with H323Alias = key from this collection.

public virtual UserEntry GetEntryFromLocalCollectionByH323Alias(string key)

Parameters

key string

H323Alias

Returns

UserEntry

Entry from collection

Remarks

Thread Safety: safe

Exceptions

Exception

Will be thrown if item is not in collection.

GetEntryFromLocalCollectionByLanPhonePin(string)

Retrieves the item with LanPhonePin = key from this collection.

public virtual UserEntry GetEntryFromLocalCollectionByLanPhonePin(string key)

Parameters

key string

LanPhonePin

Returns

UserEntry

Entry from collection

Remarks

Thread Safety: safe

Exceptions

Exception

Will be thrown if item is not in collection.

GetEntryFromLocalCollectionByName(string)

Retrieves the item with Name = key from this collection.

public virtual UserEntry GetEntryFromLocalCollectionByName(string key)

Parameters

key string

Name

Returns

UserEntry

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 UserEntry GetObjectByPrimaryKey(int UserID)

Parameters

UserID int

Returns

UserEntry

Entry

Remarks

Thread Safety: safe

Remove(UserEntry)

Removes the item from the collection.

public virtual void Remove(UserEntry entry)

Parameters

entry UserEntry

Entry to be removed.

Remarks

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