Class GroupEnum

Namespace
SWConfigDataClientLib.Proxies.Groups
Assembly
IpPbxCDSClientLib.dll

<CDSClientLib.EnumSummary> GroupEnum GroupEntry</CDSClientLib.EnumSummary>

public class GroupEnum : GroupEnumBase, SEnum
Inheritance
SWCFProxy<GroupEnumClient, IGroupEnum>
SWCFEnum<GroupEnumClient, IGroupEnum>
GroupEnum
Implements
Inherited Members

Remarks

<CDSClientLib.EnumRemarks></CDSClientLib.EnumRemarks>

Constructors

GroupEnum()

standard constructor

public GroupEnum()

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

AddUserToEnumByGroupID(int)

Reads an group configration item from the database and adds it to the local enumeration. If the group 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 GroupEntry AddUserToEnumByGroupID(int GroupID)

Parameters

GroupID int

The ID of the group to be added.

Returns

GroupEntry

AddUserToEnumByName(string)

Reads an group configration item from the database and adds it to the local enumeration. If the group 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 GroupEntry AddUserToEnumByName(string GroupName)

Parameters

GroupName string

The name of the group to be added.

Returns

GroupEntry

CheckVersion() 

public void CheckVersion()

Clear()

Removes all items from collection. The removed item list will be cleared also.DataSet on server will be removed also

public override void Clear()

CreateClient(Binding, EndpointAddress) 

protected override GroupEnumClient CreateClient(Binding binding, EndpointAddress endpointAdrress)

Parameters

binding Binding
endpointAdrress EndpointAddress

Returns

GroupEnumClient

Dispose()

Calls Clear()

public override void Dispose()

ExceuteEveryoneGroupFilter(bool, OrderByList)

Sets filter on groups flag IsErveryoneGroup creates and executes SQL query on user table in configuration database

public void ExceuteEveryoneGroupFilter(bool isEveryoneGroup, OrderByList orderByList)

Parameters

isEveryoneGroup bool

true or false

orderByList OrderByList

"order by" list for select on user table

Remarks

This is a remote method.

ExceuteInternalNameFilter(string, OrderByList)

Sets filter on user internal name creates and executes SQL query on user table in configuration database

public void ExceuteInternalNameFilter(string internalNameFilter, OrderByList orderByList)

Parameters

internalNameFilter string

filter string with optional SQL LIKE wildcards.

orderByList OrderByList

"order by" list for select on user table

Remarks

This is a remote method.

ExecuteIDFilter(int)

Sets filter on group id creates and executes SQL query on user table in configuration database

public void ExecuteIDFilter(int GroupID)

Parameters

GroupID int

GroupID.

Remarks

This is a remote method.

ExecuteNameFilter(string)

Sets filter on user name creates and executes SQL query on user table in configuration database

public void ExecuteNameFilter(string nameFilter)

Parameters

nameFilter string

filter string with optional SQL LIKE wildcards.

Remarks

This is a remote method.

ExecuteNameFilter(string, OrderByList)

Sets filter on user name creates and executes SQL query on user table in configuration database

public void ExecuteNameFilter(string nameFilter, OrderByList orderByList)

Parameters

nameFilter string

filter string with optional SQL LIKE wildcards.

orderByList OrderByList

"order by" list for select on user table

Remarks

This is a remote method.

ExecuteNameFilter(string, bool) 

public void ExecuteNameFilter(string szFilter, bool forUpdate)

Parameters

szFilter string
forUpdate bool

FreeForReuse() 

public override void FreeForReuse()

GetCurrentUserID() 

public int GetCurrentUserID()

Returns

int

GetCurrentUserName() 

public string GetCurrentUserName()

Returns

string

GetCustomExistingEntry(TGroupEntry) 

protected override GroupEntry GetCustomExistingEntry(TGroupEnum.TGroupEntry tEntry)

Parameters

tEntry TGroupEnum.TGroupEntry

Returns

GroupEntry

Remarks

Thread Safety: safe

GetGroup(int, bool) 

public GroupEntry GetGroup(int groupId, bool forUpdate)

Parameters

groupId int
forUpdate bool

Returns

GroupEntry

GetInternalNumbersWithOwnersView()

Retrieves a view including all internal numbers with additional owner information (Can be user or group) and a list (string) with all public numbers. This method is intended to be used in substitution number configuration.

public InternalNumbersWithOwnersViewPrimaryCollection GetInternalNumbersWithOwnersView()

Returns

InternalNumbersWithOwnersViewPrimaryCollection

Collection of internal numbers with mapped public numbers and owners (user or group)

GetLocalSiteID()

Returns the local site id of this site.

public int GetLocalSiteID()

Returns

int

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

GetPublicNumbersWithOwnersView()

Retrieves a view including all public numbers with additional owner information (Can be user or group). This method is intended to be used in substitution number configuration.

public PublicNumbersWithOwnersViewPrimaryCollection GetPublicNumbersWithOwnersView()

Returns

PublicNumbersWithOwnersViewPrimaryCollection

Collection of public numbers with mapped internal numbers and owners (user or group)

GetServerRequestTimeout(GroupEnumClient) 

protected override TimeSpan GetServerRequestTimeout(GroupEnumClient client)

Parameters

client GroupEnumClient

Returns

TimeSpan

GetSupportedClientVersions() 

public SStringList GetSupportedClientVersions()

Returns

SStringList

HasRole(BuildInRoles) 

public bool HasRole(BuildInRoles eRole)

Parameters

eRole BuildInRoles

Returns

bool

IsGroupId(int) 

public bool IsGroupId(int groupId)

Parameters

groupId int

Returns

bool

PingService(GroupEnumClient) 

protected override void PingService(GroupEnumClient client)

Parameters

client GroupEnumClient

ResetGroupCallDeliveryDisabledFlag(int?)

Resets the call delivery disable flag on all members of a group or on all groups

public void ResetGroupCallDeliveryDisabledFlag(int? groupId)

Parameters

groupId int?

The id of the group. If id is null all flags on all groups will be removed.

SetGroupCallDeliveryDisabledFlag(int, int, bool)

Sets flag that disables the call delivery for one member of a group. Calls to the group will not delivered to the user is the flag is set.

public bool SetGroupCallDeliveryDisabledFlag(int groupId, int userId, bool value)

Parameters

groupId int

Id of the group

userId int

Id of the user. User has to be a memeber of the group.

value bool

true or false

Returns

bool

SetInternalNameFilter(string, OrderByList)

Sets filter on user internal name Does not execute the Query. To Exceute the Query use ReadNextBlock method.

public void SetInternalNameFilter(string internalNameFilter, OrderByList orderByList)

Parameters

internalNameFilter string

filter string with optional SQL LIKE wildcards.

orderByList OrderByList

"order by" list for select on user table

SetNameFilter(string, OrderByList)

Sets filter on user name Does not execute the Query. To Exceute the Query use ReadNextBlock method.

public void SetNameFilter(string nameFilter, OrderByList orderByList)

Parameters

nameFilter string

filter string with optional SQL LIKE wildcards.

orderByList OrderByList

"order by" list for select on user table

containsGroupByName(string)

Returns true when a GroupEntry with the name exist in this enumeration

public bool containsGroupByName(string Name)

Parameters

Name string

The Name of the group.

Returns

bool

getGroupEntryFromCollection(string)

Retrieves a GroupEntry from the item enumeration by name

public GroupEntry getGroupEntryFromCollection(string Name)

Parameters

Name string

The Name of the group.

Returns

GroupEntry

Exceptions

SArgumentException

when group not found

setGroupIsEveryoneGroupFilter(bool, OrderByList)

Sets filter on group flag IsEveryoneGroup Does not execute the Query. To Exceute the Query use ReadNextBlock method.

public void setGroupIsEveryoneGroupFilter(bool isEveryoneGroup, OrderByList orderByList)

Parameters

isEveryoneGroup bool

true of false

orderByList OrderByList

"order by" list for select on user table