Package co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest

Enclosing class:

Enterprise

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

Get a list of users and their Hoteling Guest service status (active or not active). The response is either EnterpriseUserHotelingGuestSettingsGetListResponse 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 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
EnterpriseUserHotelingGuestSettingsGetListRequest()
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByDn sortByDn, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByExtension sortByExtension, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByGroupId sortByGroupId, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByServiceStatus sortByServiceStatus, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByUserDepartment sortByUserDepartment, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByUserFirstName sortByUserFirstName, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(SortByUserLastName sortByUserLastName, Enterprise enterprise, ResponsePagingControl responsePagingControl)
EnterpriseUserHotelingGuestSettingsGetListRequest(Enterprise enterprise, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	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()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortByDn	getSortByDn()
SortByExtension	getSortByExtension()
SortByGroupId	getSortByGroupId()
SortByServiceStatus	getSortByServiceStatus()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	includeVirtualUsersFlagExist()
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setFlagIncludeVirtualUsers()
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByDn(SortByDn sortByDn)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByExtension(SortByExtension sortByExtension)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByGroupId(SortByGroupId sortByGroupId)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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 Detail

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

Constructor Detail

EnterpriseUserHotelingGuestSettingsGetListRequest

public EnterpriseUserHotelingGuestSettingsGetListRequest()

EnterpriseUserHotelingGuestSettingsGetListRequest

public EnterpriseUserHotelingGuestSettingsGetListRequest(Enterprise enterprise,
                                                         ResponsePagingControl responsePagingControl)

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

EnterpriseUserHotelingGuestSettingsGetListRequest

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

Method Detail

setEnterprise

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setResponsePagingControl

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setSortByDn

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByDn(SortByDn sortByDn)

getSortByDn

public SortByDn getSortByDn()

setSortByExtension

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension)

getSortByExtension

public SortByExtension getSortByExtension()

setSortByServiceStatus

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)

getSortByServiceStatus

public SortByServiceStatus getSortByServiceStatus()

setSortByGroupId

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByGroupId(SortByGroupId sortByGroupId)

getSortByGroupId

public SortByGroupId getSortByGroupId()

setFlagIncludeVirtualUsers

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setFlagIncludeVirtualUsers()

includeVirtualUsersFlagExist

public boolean includeVirtualUsersFlagExist()

getIncludeVirtualUsers

public Boolean getIncludeVirtualUsers()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaEmailAddress

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

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

getEmptyObject

public static Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest 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.EnterpriseUserHotelingGuestSettingsGetListResponse>