Class InternalNumberEnum

Namespace

SWConfigDataClientLib.Proxies.InternalNumbers

Assembly

IpPbxCDSClientLib.dll

<CDSClientLib.EnumSummary> InternalNumberEnum InternalNumberEntry</CDSClientLib.EnumSummary>

public class InternalNumberEnum : InternalNumberEnumBase, SEnum

Inheritance

object

SWCFProxy<InternalNumberEnumClient, IInternalNumberEnum>

SWCFEnum<InternalNumberEnumClient, IInternalNumberEnum>

InternalNumberEnumBase

InternalNumberEnum

Implements

SEnum

Inherited Members

InternalNumberEnumBase._OrderByList

InternalNumberEnumBase.ClassTrace

InternalNumberEnumBase.objectList

InternalNumberEnumBase.GetCurrentObject()

InternalNumberEnumBase.GetExistingEntry(TInternalNumberEnum.TInternalNumberEntry)

InternalNumberEnumBase.Update()

InternalNumberEnumBase.Reload()

InternalNumberEnumBase.Count()

InternalNumberEnumBase.GetObjectByPrimaryKey(int)

InternalNumberEnumBase.GetOrderByList()

InternalNumberEnumBase.getValueLists(ValueLists)

InternalNumberEnumBase.PrimaryCollection

Remarks

<CDSClientLib.EnumRemarks></CDSClientLib.EnumRemarks>

Constructors

InternalNumberEnum()

standard contructor

public InternalNumberEnum()

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

AddInternalNumber(InternalNumberEntry)

Adds a InternalNumber

public void AddInternalNumber(InternalNumberEntry entry)

Parameters

entry InternalNumberEntry

New InternalNumber item

Remarks

This is a remote method.

CheckNewInternalNumber(string)

Checks if the given InternalNumber is unused as internal number, portBundleAccessPrefix or public access prefix Returns true is the InternalNumber is unused. Internal Numbers can't overlap.

public bool CheckNewInternalNumber(string internalNumber)

Parameters

internalNumber string

The new number to be tested

Returns

bool

true is unused

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 InternalNumberEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

InternalNumberEnumClient

DeleteInternalNmberEntry(int)

Deletes a InternalNumber

public void DeleteInternalNmberEntry(int InternalNumberID)

Parameters

InternalNumberID int

id of InternalNumber

Remarks

This is a remote method.

Dispose()

Calls Clear()

public override void Dispose()

ExecuteFilter(OrderByList)

Sets filter on InternalNumbers by the get all entries itself creates and executes SQL query on Internal Numbers table in configuration database

public void ExecuteFilter(OrderByList orderByList)

Parameters

orderByList OrderByList

Remarks

This is a remote method.

ExecuteIDFilter(int)

Sets filter on InternalNumbers by InternalNumberID creates and executes SQL query on InternalNumbers table in configuration database

public void ExecuteIDFilter(int InternalNumberID)

Parameters

InternalNumberID int

The EntryID.

Remarks

This is a remote method.

ExecuteNumberFilter(string, OrderByList)

Sets filter on InternalNumbers by the Number itself creates and executes SQL query on Internal Numbers table in configuration database

public void ExecuteNumberFilter(string Number, OrderByList orderByList)

Parameters

Number string

The EntryID.

orderByList OrderByList

the order

Remarks

This is a remote method.

ExecuteNumberFilterByGroupID(int, OrderByList)

Sets filter on InternalNumbers by GroupID creates and executes SQL query on Internal Numbers table in configuration database

public void ExecuteNumberFilterByGroupID(int GroupID, OrderByList orderByList)

Parameters

GroupID int

orderByList OrderByList

the order

Remarks

This is a remote method.

ExecuteNumberFilterByUserID(int, OrderByList)

Sets filter on InternalNumbers by UserID creates and executes SQL query on Internal Numbers table in configuration database

public void ExecuteNumberFilterByUserID(int UserID, OrderByList orderByList)

Parameters

UserID int

The users ID.

orderByList OrderByList

the order

Remarks

This is a remote method.

FreeForReuse()

public override void FreeForReuse()

GetCollisionInfosForInternalNumber(string)

Returns a list of internal, public access prefixes or portbunde access prefixes that collides with the given number

public ICollection<InternalCollisionInfo> GetCollisionInfosForInternalNumber(string InternalNumber)

Parameters

InternalNumber string

number to be checked

Returns

ICollection<InternalCollisionInfo>

List of collisions

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetCustomExistingEntry(TInternalNumberEntry)

protected override InternalNumberEntry GetCustomExistingEntry(TInternalNumberEnum.TInternalNumberEntry tEntry)

Parameters

tEntry TInternalNumberEnum.TInternalNumberEntry

Returns

InternalNumberEntry

Remarks

Thread Safety: safe

GetNextInternalNumber(string)

Returns the next free internalNumber

public string GetNextInternalNumber(string InternalNumber)

Parameters

InternalNumber string

First internal number to be checked. The number can only contains digits

Returns

string

The next free number

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

GetRestrictedInternalNumberUsageView()

public List<RestrictedInternalNumberUsageViewEntry> GetRestrictedInternalNumberUsageView()

Returns

List<RestrictedInternalNumberUsageViewEntry>

GetServerRequestTimeout(InternalNumberEnumClient)

protected override TimeSpan GetServerRequestTimeout(InternalNumberEnumClient client)

Parameters

client InternalNumberEnumClient

Returns

TimeSpan

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

GetValidPortBundlesForPublicNumber(string)

Retrieves a collection of PortBundles (Id and Name) which are vailid for the public number The PortBundles can be used for the PreferredPublicNumber Table.

public ValidPortBundlePrimaryCollection GetValidPortBundlesForPublicNumber(string publicNumber)

Parameters

publicNumber string

The number in 'normalized' form. (Cononical, SIPUri etc.)

Returns

ValidPortBundlePrimaryCollection

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(InternalNumberEnumClient)

protected override void PingService(InternalNumberEnumClient client)

Parameters

client InternalNumberEnumClient