Package co.ecg.alpaca.toolkit.generated

Class Group.GroupUserHotelingGuestSettingsGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupUserHotelingGuestSettingsGetListRequest

Enclosing class:

Group

@ChoiceGroup("sortByUserLastName") @ChoiceGroup("sortByUserFirstName") @ChoiceGroup("sortByUserDepartment") @ChoiceGroup("sortByDn") @ChoiceGroup("sortByExtension") @ChoiceGroup("sortByServiceStatus")
public static class Group.GroupUserHotelingGuestSettingsGetListRequest
extends Request<Group.GroupUserHotelingGuestSettingsGetListResponse>

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Group.GroupUserHotelingGuestSettingsGetListRequest	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()
SortByServiceStatus	getSortByServiceStatus()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	includeVirtualUsersFlagExist()
Group.GroupUserHotelingGuestSettingsGetListRequest	setFlagIncludeVirtualUsers()
Group.GroupUserHotelingGuestSettingsGetListRequest	setGroup(Group group)
Group.GroupUserHotelingGuestSettingsGetListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSortByDn(SortByDn sortByDn)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSortByExtension(SortByExtension sortByExtension)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
Group.GroupUserHotelingGuestSettingsGetListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
Group.GroupUserHotelingGuestSettingsGetListRequest	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

group

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

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

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

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest()

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByUserLastName sortByUserLastName,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByUserFirstName sortByUserFirstName,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByUserDepartment sortByUserDepartment,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByDn sortByDn,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByExtension sortByExtension,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

GroupUserHotelingGuestSettingsGetListRequest

public GroupUserHotelingGuestSettingsGetListRequest(SortByServiceStatus sortByServiceStatus,
                                                    Group group,
                                                    ResponsePagingControl responsePagingControl)

Method Detail

setGroup

public Group.GroupUserHotelingGuestSettingsGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setResponsePagingControl

public Group.GroupUserHotelingGuestSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setSortByDn

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByDn(SortByDn sortByDn)

getSortByDn

public SortByDn getSortByDn()

setSortByExtension

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension)

getSortByExtension

public SortByExtension getSortByExtension()

setSortByServiceStatus

public Group.GroupUserHotelingGuestSettingsGetListRequest setSortByServiceStatus(SortByServiceStatus sortByServiceStatus)

getSortByServiceStatus

public SortByServiceStatus getSortByServiceStatus()

setFlagIncludeVirtualUsers

public Group.GroupUserHotelingGuestSettingsGetListRequest setFlagIncludeVirtualUsers()

includeVirtualUsersFlagExist

public boolean includeVirtualUsersFlagExist()

getIncludeVirtualUsers

public Boolean getIncludeVirtualUsers()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaEmailAddress

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

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public Group.GroupUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserInTrunkGroup

public Group.GroupUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

getEmptyObject

public static Group.GroupUserHotelingGuestSettingsGetListRequest 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.GroupUserHotelingGuestSettingsGetListResponse>