Package co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Enterprise.EnterpriseUserCallWaitingSettingsGetListResponse>

co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest

Enclosing class:

Enterprise

@ChoiceGroup("sortByUserLastName") @ChoiceGroup("sortByUserFirstName") @ChoiceGroup("sortByUserDepartment") @ChoiceGroup("sortByDn") @ChoiceGroup("sortByExtension") @ChoiceGroup("sortByServiceStatus") @ChoiceGroup("sortByGroupId")
public static class Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest
extends Request<Enterprise.EnterpriseUserCallWaitingSettingsGetListResponse>

Get a list of users and the Call Waiting service status (active or not active). The response is either EnterpriseUserCallWaitingSettingsGetListResponse 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 @Valid Enterprise	enterprise
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 SearchCriteriaServiceStatus	searchCriteriaServiceStatus
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid SortByDn	sortByDn
protected @Valid SortByExtension	sortByExtension
protected @Valid SortByGroupId	sortByGroupId
protected @Valid SortByServiceStatus	sortByServiceStatus
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
EnterpriseUserCallWaitingSettingsGetListRequest()
EnterpriseUserCallWaitingSettingsGetListRequest(SortByDn sortByDn, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByExtension sortByExtension, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByGroupId sortByGroupId, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByServiceStatus sortByServiceStatus, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserDepartment sortByUserDepartment, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserFirstName sortByUserFirstName, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserLastName sortByUserLastName, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserCallWaitingSettingsGetListRequest(Enterprise enterprise, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
Boolean	getIncludeVirtualUsers()
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserInTrunkGroup	getSearchCriteriaExactUserInTrunkGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaServiceStatus	getSearchCriteriaServiceStatus()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortByDn	getSortByDn()
SortByExtension	getSortByExtension()
SortByGroupId	getSortByGroupId()
SortByServiceStatus	getSortByServiceStatus()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	includeVirtualUsersFlagExist()
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setFlagIncludeVirtualUsers()
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaServiceStatus(SearchCriteriaServiceStatus searchCriteriaServiceStatus)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByDn(SortByDn sortByDn)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByExtension(SortByExtension sortByExtension)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByGroupId(SortByGroupId sortByGroupId)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest	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

enterprise

@NotNull
@Valid
protected transient @NotNull @Valid Enterprise enterprise

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

sortByServiceStatus

@Valid
protected @Valid SortByServiceStatus sortByServiceStatus

sortByGroupId

@Valid
protected @Valid SortByGroupId sortByGroupId

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

searchCriteriaServiceStatus

@Valid
protected @Valid SearchCriteriaServiceStatus searchCriteriaServiceStatus

Constructor Details

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest()

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserLastName sortByUserLastName,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserFirstName sortByUserFirstName,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByUserDepartment sortByUserDepartment,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByDn sortByDn,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByExtension sortByExtension,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByServiceStatus sortByServiceStatus,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallWaitingSettingsGetListRequest

public EnterpriseUserCallWaitingSettingsGetListRequest(SortByGroupId sortByGroupId,
 Enterprise enterprise,
 ResponsePagingControl responsePagingControl)

Method Details

setEnterprise

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setResponsePagingControl

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setSortByDn

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByDn(SortByDn sortByDn)

getSortByDn

public SortByDn getSortByDn()

setSortByExtension

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension)

getSortByExtension

public SortByExtension getSortByExtension()

setSortByServiceStatus

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)

getSortByServiceStatus

public SortByServiceStatus getSortByServiceStatus()

setSortByGroupId

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSortByGroupId(SortByGroupId sortByGroupId)

getSortByGroupId

public SortByGroupId getSortByGroupId()

setFlagIncludeVirtualUsers

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setFlagIncludeVirtualUsers()

includeVirtualUsersFlagExist

public boolean includeVirtualUsersFlagExist()

getIncludeVirtualUsers

public Boolean getIncludeVirtualUsers()

setSearchCriteriaUserLastName

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaEmailAddress

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

setSearchCriteriaServiceStatus

public Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest setSearchCriteriaServiceStatus(SearchCriteriaServiceStatus searchCriteriaServiceStatus)

getSearchCriteriaServiceStatus

public SearchCriteriaServiceStatus getSearchCriteriaServiceStatus()

getEmptyObject

public static Enterprise.EnterpriseUserCallWaitingSettingsGetListRequest 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<Enterprise.EnterpriseUserCallWaitingSettingsGetListResponse>