Class LocationEnum

Namespace

SWConfigDataClientLib.Proxies.Locations

Assembly

IpPbxCDSClientLib.dll

<CDSClientLib.EnumSummary> LocationEntry LocationEnum</CDSClientLib.EnumSummary>

public class LocationEnum : LocationEnumBase, SEnum

Inheritance

object

SWCFProxy<LocationEnumClient, ILocationEnum>

SWCFEnum<LocationEnumClient, ILocationEnum>

LocationEnumBase

LocationEnum

Implements

SEnum

Inherited Members

LocationEnumBase._OrderByList

LocationEnumBase.ClassTrace

LocationEnumBase.objectList

LocationEnumBase.GetCurrentObject()

LocationEnumBase.GetExistingEntry(TLocationEnum.TLocationEntry)

LocationEnumBase.Update()

LocationEnumBase.Reload()

LocationEnumBase.Count()

LocationEnumBase.GetObjectByPrimaryKey(int)

LocationEnumBase.GetOrderByList()

LocationEnumBase.getValueLists(ValueLists)

LocationEnumBase.PrimaryCollection

Remarks

<CDSClientLib.EnumRemarks></CDSClientLib.EnumRemarks>

Constructors

LocationEnum()

standard contructor

public LocationEnum()

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

AddLocationToEnumByID(int)

Reads an user configration item from the database and adds it to the local enumeration. If the location configration item already exists in the local enumeration, the old entry will be removed before the new one will be added. Any sortings of the local enumeration will be ignored.

public LocationEntry AddLocationToEnumByID(int LocationID)

Parameters

LocationID int

The id of the location to be added.

Returns

LocationEntry

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

Parameters

binding Binding

endpointAdrress EndpointAddress

Returns

LocationEnumClient

Dispose()

Calls Clear()

public override void Dispose()

ExecuteAllFilter(OrderByList)

Sets filter on Location retrieving all entries. creates and executes SQL query on Location table in configuration database

public void ExecuteAllFilter(OrderByList orderByList)

Parameters

orderByList OrderByList

List of order statements. If the list is empty default ordering is used.

Remarks

This is a remote method.

ExecuteFilterDefaultLocation()

Sets filter on Location returning the default location creates and executes SQL query on Location table in configuration database

public void ExecuteFilterDefaultLocation()

Remarks

This is a remote method.

ExecuteIDFilter(int)

Sets filter on Location by LocationID creates and executes SQL query on Location table in configuration database

public void ExecuteIDFilter(int LocationID)

Parameters

LocationID int

The EntryID.

Remarks

This is a remote method.

ExecuteNameFilter(string, OrderByList)

Sets filter on Location by the Name of the Location creates and executes SQL query on Location table in configuration database

public void ExecuteNameFilter(string Name, OrderByList orderByList)

Parameters

Name string

The Name of the Location with optional SQL LIKE wildcards.

orderByList OrderByList

List of order statements. If the list is empty default ordering is used.

Remarks

This is a remote method.

FreeForReuse()

public override void FreeForReuse()

GetAllSystemTimeZones()

Retrieves a list of all system time zones from the server. The list will be sorted by the bias.

public STimeZoneInformationList GetAllSystemTimeZones()

Returns

STimeZoneInformationList

GetCurrentUserID()

public int GetCurrentUserID()

Returns

int

GetCurrentUserName()

public string GetCurrentUserName()

Returns

string

GetCustomExistingEntry(TLocationEntry)

protected override LocationEntry GetCustomExistingEntry(TLocationEnum.TLocationEntry tEntry)

Parameters

tEntry TLocationEnum.TLocationEntry

Returns

LocationEntry

Remarks

Thread Safety: safe

GetLocationFromLocalCollectionByCanonicalNumber(string)

Retrieves a LocationEntry from the local collection which machtes the given number

public LocationEntry GetLocationFromLocalCollectionByCanonicalNumber(string canonicalNumber)

Parameters

canonicalNumber string

number to match

Returns

LocationEntry

First LocationEntry with matching configuration.

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

protected override TimeSpan GetServerRequestTimeout(LocationEnumClient client)

Parameters

client LocationEnumClient

Returns

TimeSpan

GetSupportedClientVersions()

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles)

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

PingService(LocationEnumClient)

protected override void PingService(LocationEnumClient client)

Parameters

client LocationEnumClient