Class EditablePhonebookEnum

Namespace
SWConfigDataClientLib.Proxies.EditablePhonebook
Assembly
IpPbxCDSClientLib.dll

<CDSClientLib.EnumSummary> EditablePhonebookEntry EditablePhonebookEnum</CDSClientLib.EnumSummary>

public class EditablePhonebookEnum : EditablePhonebookEnumBase, SEnum
Inheritance
SWCFProxy<EditablePhonebookEnumClient, IEditablePhonebookEnum>
SWCFEnum<EditablePhonebookEnumClient, IEditablePhonebookEnum>
EditablePhonebookEnum
Implements
Inherited Members

Remarks

<CDSClientLib.EnumRemarks></CDSClientLib.EnumRemarks>

Constructors

EditablePhonebookEnum()

Standard Constructor. Used only by the unamanged wrapper.

public EditablePhonebookEnum()

Properties

PoolMaxSize

depcreated

public static int PoolMaxSize { get; set; }

Property Value

int

PoolMinSize

depcreated

public static int PoolMinSize { get; set; }

Property Value

int

m_BaseUrl 

protected override string m_BaseUrl { get; }

Property Value

string

Methods

AddEditablePhoneBookEntry(EditablePhonebookEntry)

Adds a new EditablePhoneBook Entry (item) Creates and executes SQL update on EditablePhonebook table in configuration database.

public void AddEditablePhoneBookEntry(EditablePhonebookEntry entry)

Parameters

entry EditablePhonebookEntry

The entry object to be added.

Remarks

This is a remote method.

CheckVersion() 

public void CheckVersion()

Clear()

Removes all itmes and filters, DataSet on server will be removed also

public override void Clear()

Remarks

The items will not be deleted in database.

CreateClient(Binding, EndpointAddress) 

protected override EditablePhonebookEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

EditablePhonebookEnumClient

DeleteEditablePhoneBookEntry(int)

Deletes an EditablePhoneBookEntry item

public void DeleteEditablePhoneBookEntry(int EntryID)

Parameters

EntryID int

ID of entry to be deleted.

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

Dispose()

Calls Clear()

public override void Dispose()

ExecuteFilter()

Sets filter on EditablePhoneBook retreiving all entries. Creates and executes the SQL query on EditablePhonebook table in configuration database.

public void ExecuteFilter()

Remarks

This is a remote method.

ExecuteFilter(int)

Sets filter on EditablePhoneBook by EntryID. Creates and executes the SQL query on EditablePhonebook table in configuration database.

public void ExecuteFilter(int EntryID)

Parameters

EntryID int

The EntryID.

Remarks

This is a remote method.

FindEditablePhoneBookEntry(ref string, ref string, ref string, ref int, string)

find an editable phonebook entry

public void FindEditablePhoneBookEntry(ref string rszNumber, ref string rszSearchNumber, ref string rszDesc, ref int rEntryId, string rszName)

Parameters

rszNumber string

phone book entry number when successful

rszSearchNumber string

phone book entry searchnumber when successful

rszDesc string

phone book entry description when successful

rEntryId int

phone book entry id when successfull

rszName string

rszName name to search for

Remarks

This is a remote method.

Exceptions

UserDbException

On database failure

FreeForReuse() 

public override void FreeForReuse()

GetCurrentUserID() 

public int GetCurrentUserID()

Returns

int

GetCurrentUserName() 

public string GetCurrentUserName()

Returns

string

GetPossibleIpPbxUserNames()

Returns all possible IpPbx User Names of the current user. Can be more than one if the current user is a windows user and multiple IppPbxUser are assigned to his windows account.

public SStringList GetPossibleIpPbxUserNames()

Returns

SStringList

StringList

GetServerRequestTimeout(EditablePhonebookEnumClient) 

protected override TimeSpan GetServerRequestTimeout(EditablePhonebookEnumClient client)

Parameters

client EditablePhonebookEnumClient

Returns

TimeSpan

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(EditablePhonebookEnumClient) 

protected override void PingService(EditablePhonebookEnumClient client)

Parameters

client EditablePhonebookEnumClient