Package co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest

Enclosing class:

Enterprise

@ChoiceGroup("sortByUserLastName") @ChoiceGroup("sortByUserFirstName") @ChoiceGroup("sortByUserDepartment") @ChoiceGroup("sortByDn") @ChoiceGroup("sortByExtension") @ChoiceGroup("sortByGroupId") @ChoiceGroup("sortByForwardedToNumber")
public static class Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest
extends Request<Enterprise.EnterpriseUserCallForwardingSettingsGetListResponse>

Get a list of users and the service settings for a Call Forwarding service. The response is either EnterpriseUserCallForwardingSettingsGetListResponse 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 CallForwardingService	callForwardingService
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 SearchCriteriaForwardedToNumber[]	searchCriteriaForwardedToNumber
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid SortByDn	sortByDn
protected @Valid SortByExtension	sortByExtension
protected @Valid SortByForwardedToNumber	sortByForwardedToNumber
protected @Valid SortByGroupId	sortByGroupId
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
EnterpriseUserCallForwardingSettingsGetListRequest()
EnterpriseUserCallForwardingSettingsGetListRequest(SortByDn sortByDn, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByExtension sortByExtension, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByForwardedToNumber sortByForwardedToNumber, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByGroupId sortByGroupId, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserDepartment sortByUserDepartment, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserFirstName sortByUserFirstName, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserLastName sortByUserLastName, Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)
EnterpriseUserCallForwardingSettingsGetListRequest(Enterprise enterprise, CallForwardingService callForwardingService, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CallForwardingService	getCallForwardingService()
static Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	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()
SearchCriteriaForwardedToNumber[]	getSearchCriteriaForwardedToNumber()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortByDn	getSortByDn()
SortByExtension	getSortByExtension()
SortByForwardedToNumber	getSortByForwardedToNumber()
SortByGroupId	getSortByGroupId()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	includeVirtualUsersFlagExist()
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setCallForwardingService(CallForwardingService callForwardingService)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setFlagIncludeVirtualUsers()
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaForwardedToNumber(SearchCriteriaForwardedToNumber... searchCriteriaForwardedToNumber)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByDn(SortByDn sortByDn)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByExtension(SortByExtension sortByExtension)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByForwardedToNumber(SortByForwardedToNumber sortByForwardedToNumber)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByGroupId(SortByGroupId sortByGroupId)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest	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

callForwardingService

@NotNull
protected @NotNull CallForwardingService callForwardingService

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

sortByGroupId

@Valid
protected @Valid SortByGroupId sortByGroupId

sortByForwardedToNumber

@Valid
protected @Valid SortByForwardedToNumber sortByForwardedToNumber

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

searchCriteriaForwardedToNumber

@Valid
protected @Valid SearchCriteriaForwardedToNumber[] searchCriteriaForwardedToNumber

Constructor Details

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest()

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserLastName sortByUserLastName,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserFirstName sortByUserFirstName,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByUserDepartment sortByUserDepartment,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByDn sortByDn,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByExtension sortByExtension,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByGroupId sortByGroupId,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

EnterpriseUserCallForwardingSettingsGetListRequest

public EnterpriseUserCallForwardingSettingsGetListRequest(SortByForwardedToNumber sortByForwardedToNumber,
 Enterprise enterprise,
 CallForwardingService callForwardingService,
 ResponsePagingControl responsePagingControl)

Method Details

setEnterprise

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setCallForwardingService

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setCallForwardingService(CallForwardingService callForwardingService)

getCallForwardingService

public CallForwardingService getCallForwardingService()

setResponsePagingControl

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setSortByDn

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByDn(SortByDn sortByDn)

getSortByDn

public SortByDn getSortByDn()

setSortByExtension

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension)

getSortByExtension

public SortByExtension getSortByExtension()

setSortByGroupId

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByGroupId(SortByGroupId sortByGroupId)

getSortByGroupId

public SortByGroupId getSortByGroupId()

setSortByForwardedToNumber

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSortByForwardedToNumber(SortByForwardedToNumber sortByForwardedToNumber)

getSortByForwardedToNumber

public SortByForwardedToNumber getSortByForwardedToNumber()

setFlagIncludeVirtualUsers

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setFlagIncludeVirtualUsers()

includeVirtualUsersFlagExist

public boolean includeVirtualUsersFlagExist()

getIncludeVirtualUsers

public Boolean getIncludeVirtualUsers()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaEmailAddress

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

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

setSearchCriteriaForwardedToNumber

public Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest setSearchCriteriaForwardedToNumber(SearchCriteriaForwardedToNumber... searchCriteriaForwardedToNumber)

getSearchCriteriaForwardedToNumber

public SearchCriteriaForwardedToNumber[] getSearchCriteriaForwardedToNumber()

getEmptyObject

public static Enterprise.EnterpriseUserCallForwardingSettingsGetListRequest 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.EnterpriseUserCallForwardingSettingsGetListResponse>