Package co.ecg.alpaca.toolkit.generated

Class Group.GroupUserCallingPlanSettingsGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupUserCallingPlanSettingsGetListResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupUserCallingPlanSettingsGetListRequest

Enclosing class:

Group

@ChoiceGroup("sortByUserLastName") @ChoiceGroup("sortByUserFirstName") @ChoiceGroup("sortByUserDepartment") @ChoiceGroup("sortByDn") @ChoiceGroup("sortByExtension")
public static class Group.GroupUserCallingPlanSettingsGetListRequest
extends Request<Group.GroupUserCallingPlanSettingsGetListResponse>

Get a list of users and the default or custom calling plan setting. The response is either GroupUserCallingPlanSettingsGetListResponse or ErrorResponse. By default, virtual users and non-virtual users that match the selected search criteria are included in the response when "includeVirtualUsers" is present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users are returned. The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull CallingPlanService	callingPlanService
protected @NotNull @Valid Group	group
protected @AssertTrue Boolean	includeVirtualUsers
protected @NotNull @Valid ResponsePagingControl	responsePagingControl
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserInTrunkGroup	searchCriteriaExactUserInTrunkGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid SortByDn	sortByDn
protected @Valid SortByExtension	sortByExtension
protected @Valid SortByUserDepartment	sortByUserDepartment
protected @Valid SortByUserFirstName	sortByUserFirstName
protected @Valid SortByUserLastName	sortByUserLastName

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
GroupUserCallingPlanSettingsGetListRequest()
GroupUserCallingPlanSettingsGetListRequest(SortByDn sortByDn, Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)
GroupUserCallingPlanSettingsGetListRequest(SortByExtension sortByExtension, Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)
GroupUserCallingPlanSettingsGetListRequest(SortByUserDepartment sortByUserDepartment, Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)
GroupUserCallingPlanSettingsGetListRequest(SortByUserFirstName sortByUserFirstName, Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)
GroupUserCallingPlanSettingsGetListRequest(SortByUserLastName sortByUserLastName, Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)
GroupUserCallingPlanSettingsGetListRequest(Group group, CallingPlanService callingPlanService, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CallingPlanService	getCallingPlanService()
static Group.GroupUserCallingPlanSettingsGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Boolean	getIncludeVirtualUsers()
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserInTrunkGroup	getSearchCriteriaExactUserInTrunkGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortByDn	getSortByDn()
SortByExtension	getSortByExtension()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	includeVirtualUsersFlagExist()
Group.GroupUserCallingPlanSettingsGetListRequest	setCallingPlanService(CallingPlanService callingPlanService)
Group.GroupUserCallingPlanSettingsGetListRequest	setFlagIncludeVirtualUsers()
Group.GroupUserCallingPlanSettingsGetListRequest	setGroup(Group group)
Group.GroupUserCallingPlanSettingsGetListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Group.GroupUserCallingPlanSettingsGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Group.GroupUserCallingPlanSettingsGetListRequest	setSortByDn(SortByDn sortByDn)
Group.GroupUserCallingPlanSettingsGetListRequest	setSortByExtension(SortByExtension sortByExtension)
Group.GroupUserCallingPlanSettingsGetListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
Group.GroupUserCallingPlanSettingsGetListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
Group.GroupUserCallingPlanSettingsGetListRequest	setSortByUserLastName(SortByUserLastName sortByUserLastName)

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

callingPlanService

@NotNull
protected @NotNull CallingPlanService callingPlanService

responsePagingControl

@NotNull
@Valid
protected @NotNull @Valid ResponsePagingControl responsePagingControl

sortByUserLastName

@Valid
protected @Valid SortByUserLastName sortByUserLastName

sortByUserFirstName

@Valid
protected @Valid SortByUserFirstName sortByUserFirstName

sortByUserDepartment

@Valid
protected @Valid SortByUserDepartment sortByUserDepartment

sortByDn

@Valid
protected @Valid SortByDn sortByDn

sortByExtension

@Valid
protected @Valid SortByExtension sortByExtension

includeVirtualUsers

@AssertTrue
protected @AssertTrue Boolean includeVirtualUsers

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaEmailAddress

@Valid
protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserInTrunkGroup

@Valid
protected @Valid SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup

Constructor Details

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest()

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(SortByUserLastName sortByUserLastName,
 Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(SortByUserFirstName sortByUserFirstName,
 Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(SortByUserDepartment sortByUserDepartment,
 Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(SortByDn sortByDn,
 Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

GroupUserCallingPlanSettingsGetListRequest

public GroupUserCallingPlanSettingsGetListRequest(SortByExtension sortByExtension,
 Group group,
 CallingPlanService callingPlanService,
 ResponsePagingControl responsePagingControl)

Method Details

setGroup

public Group.GroupUserCallingPlanSettingsGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setCallingPlanService

public Group.GroupUserCallingPlanSettingsGetListRequest setCallingPlanService(CallingPlanService callingPlanService)

getCallingPlanService

public CallingPlanService getCallingPlanService()

setResponsePagingControl

public Group.GroupUserCallingPlanSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public Group.GroupUserCallingPlanSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public Group.GroupUserCallingPlanSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public Group.GroupUserCallingPlanSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setSortByDn

public Group.GroupUserCallingPlanSettingsGetListRequest setSortByDn(SortByDn sortByDn)

getSortByDn

public SortByDn getSortByDn()

setSortByExtension

public Group.GroupUserCallingPlanSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension)

getSortByExtension

public SortByExtension getSortByExtension()

setFlagIncludeVirtualUsers

public Group.GroupUserCallingPlanSettingsGetListRequest setFlagIncludeVirtualUsers()

includeVirtualUsersFlagExist

public boolean includeVirtualUsersFlagExist()

getIncludeVirtualUsers

public Boolean getIncludeVirtualUsers()

setSearchCriteriaUserLastName

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaEmailAddress

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public Group.GroupUserCallingPlanSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

getEmptyObject

public static Group.GroupUserCallingPlanSettingsGetListRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<Group.GroupUserCallingPlanSettingsGetListResponse>