Package co.ecg.alpaca.toolkit.generated

Class User.UserPreferredAnswerEndpointModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.User.UserPreferredAnswerEndpointModifyRequest

Enclosing class:

User

public static class User.UserPreferredAnswerEndpointModifyRequest
extends Request<DefaultResponse>

Request to configure a user's Preferred Answer Endpoint for Auto-Answer and Forced Answer. Setting preferredAnswerEndpoint to nil will clear the user's configured Preferred Answer Endpoint. The response is either a SuccessResponse or an 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 Optional<@Valid AccessDeviceEndpointKey>	preferredAnswerEndpoint
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPreferredAnswerEndpointModifyRequest()
UserPreferredAnswerEndpointModifyRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPreferredAnswerEndpointModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Valid AccessDeviceEndpointKey>	getPreferredAnswerEndpoint()
User.UserPreferredAnswerEndpointModifyRequest	setPreferredAnswerEndpoint(AccessDeviceEndpointKey preferredAnswerEndpoint)
User.UserPreferredAnswerEndpointModifyRequest	setUser(BroadWorksUser user)
User.UserPreferredAnswerEndpointModifyRequest	unsetPreferredAnswerEndpoint()

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

preferredAnswerEndpoint

protected Optional<@Valid AccessDeviceEndpointKey> preferredAnswerEndpoint

Constructor Details

UserPreferredAnswerEndpointModifyRequest

public UserPreferredAnswerEndpointModifyRequest()

UserPreferredAnswerEndpointModifyRequest

public UserPreferredAnswerEndpointModifyRequest(BroadWorksUser user)

Method Details

setUser

public User.UserPreferredAnswerEndpointModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

unsetPreferredAnswerEndpoint

public User.UserPreferredAnswerEndpointModifyRequest unsetPreferredAnswerEndpoint()

setPreferredAnswerEndpoint

public User.UserPreferredAnswerEndpointModifyRequest setPreferredAnswerEndpoint(AccessDeviceEndpointKey preferredAnswerEndpoint)

getPreferredAnswerEndpoint

public Optional<@Valid AccessDeviceEndpointKey> getPreferredAnswerEndpoint()

getEmptyObject

public static User.UserPreferredAnswerEndpointModifyRequest 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<DefaultResponse>