Package co.ecg.alpaca.toolkit.generated

Class FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListResponse>

co.ecg.alpaca.toolkit.generated.FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest

Enclosing class:

FlexibleSeatingHost

public static class FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest
extends Request<FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListResponse>

Get a list of hosts that can be assigned to flexible seating guests. The response is either UserFlexibleSeatingGuestGetAvailableUserListResponse or ErrorResponse. The response will include active hosts based on the following criteria. - host that has the equivalent device type as the guest, host already assigned to another guest and for a guest in a Service Provider host in the user’s group and for a user in an Enterprise a host within the user’s group and host in the user’s enterprise that has the accessLevel set to Enterprise.

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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserFlexibleSeatingGuestGetAvailableHostListRequest()
UserFlexibleSeatingGuestGetAvailableHostListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setResponseSizeLimit(Integer responseSizeLimit)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest	setUser(BroadWorksUser user)

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 Details

user

@NotNull @Valid protected transient @NotNull @Valid BroadWorksUser user

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaExactUserDepartment

@Valid protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaUserId

@Valid protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDn

@Valid protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

Constructor Details

UserFlexibleSeatingGuestGetAvailableHostListRequest

public UserFlexibleSeatingGuestGetAvailableHostListRequest()

UserFlexibleSeatingGuestGetAvailableHostListRequest

public UserFlexibleSeatingGuestGetAvailableHostListRequest(BroadWorksUser user)

Method Details

setUser

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setResponseSizeLimit

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaExactUserDepartment

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaUserId

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDn

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListRequest 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<FlexibleSeatingHost.UserFlexibleSeatingGuestGetAvailableHostListResponse>