Package co.ecg.alpaca.toolkit.generated

Class User.UserPreferredAnswerEndpointGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserPreferredAnswerEndpointGetListResponse>

co.ecg.alpaca.toolkit.generated.User.UserPreferredAnswerEndpointGetListRequest

Enclosing class:

User

public static class User.UserPreferredAnswerEndpointGetListRequest
extends Request<User.UserPreferredAnswerEndpointGetListResponse>

Requests the list of device endpoints of a user that can be configured as Preferred Answer Endpoint for Auto-Answer and Forced Answer. If onlyDisplayPreferredAnswerEndpoint is specified, only the Preferred Answer Endpoint of user is returned in the response. The response is either UserPreferredAnswerEndpointGetListResponse or ErrorResponse.

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 @AssertTrue Boolean	onlyDisplayPreferredAnswerEndpoint
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPreferredAnswerEndpointGetListRequest()
UserPreferredAnswerEndpointGetListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPreferredAnswerEndpointGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getOnlyDisplayPreferredAnswerEndpoint()
boolean	onlyDisplayPreferredAnswerEndpointFlagExist()
User.UserPreferredAnswerEndpointGetListRequest	setFlagOnlyDisplayPreferredAnswerEndpoint()
User.UserPreferredAnswerEndpointGetListRequest	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, 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

user

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

onlyDisplayPreferredAnswerEndpoint

@AssertTrue
protected @AssertTrue Boolean onlyDisplayPreferredAnswerEndpoint

Constructor Details

UserPreferredAnswerEndpointGetListRequest

public UserPreferredAnswerEndpointGetListRequest()

UserPreferredAnswerEndpointGetListRequest

public UserPreferredAnswerEndpointGetListRequest(BroadWorksUser user)

Method Details

setUser

public User.UserPreferredAnswerEndpointGetListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setFlagOnlyDisplayPreferredAnswerEndpoint

public User.UserPreferredAnswerEndpointGetListRequest setFlagOnlyDisplayPreferredAnswerEndpoint()

onlyDisplayPreferredAnswerEndpointFlagExist

public boolean onlyDisplayPreferredAnswerEndpointFlagExist()

getOnlyDisplayPreferredAnswerEndpoint

public Boolean getOnlyDisplayPreferredAnswerEndpoint()

getEmptyObject

public static User.UserPreferredAnswerEndpointGetListRequest 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<User.UserPreferredAnswerEndpointGetListResponse>