Package co.ecg.alpaca.toolkit.generated.services

Class UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest

Enclosing class:

UserSharedCallAppearance

public static class UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest
extends Request<DefaultResponse>

Associate/Disassociate an access device instance to the user's Shared Call Appearance. The following elements are only used in AS data mode and ignored in XS data mode: useHotline hotlineContact 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 @NotNull @Valid AccessDeviceEndpointKey	accessDeviceEndpoint
protected Boolean	allowOrigination
protected Boolean	allowTermination
protected Optional<@Size(min=1,max=161) String>	hotlineContact
protected Boolean	isActive
protected Boolean	useHotline
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserSharedCallAppearanceModifyEndpointRequest()
UserSharedCallAppearanceModifyEndpointRequest(BroadWorksUser user, AccessDeviceEndpointKey accessDeviceEndpoint)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AccessDeviceEndpointKey	getAccessDeviceEndpoint()
Boolean	getAllowOrigination()
Boolean	getAllowTermination()
BroadWorksUser	getBroadWorksUser()
static UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Size(min=1,max=161) String>	getHotlineContact()
Boolean	getIsActive()
Boolean	getUseHotline()
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setAccessDeviceEndpoint(AccessDeviceEndpointKey accessDeviceEndpoint)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setAllowOrigination(Boolean allowOrigination)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setAllowTermination(Boolean allowTermination)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setHotlineContact(String hotlineContact)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setIsActive(Boolean isActive)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setUseHotline(Boolean useHotline)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	setUser(BroadWorksUser user)
UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest	unsetHotlineContact()

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

accessDeviceEndpoint

@NotNull
@Valid
protected @NotNull @Valid AccessDeviceEndpointKey accessDeviceEndpoint

isActive

protected Boolean isActive

allowOrigination

protected Boolean allowOrigination

allowTermination

protected Boolean allowTermination

useHotline

protected Boolean useHotline

hotlineContact

protected Optional<@Size(min=1,max=161) String> hotlineContact

Constructor Details

UserSharedCallAppearanceModifyEndpointRequest

public UserSharedCallAppearanceModifyEndpointRequest()

UserSharedCallAppearanceModifyEndpointRequest

public UserSharedCallAppearanceModifyEndpointRequest(BroadWorksUser user,
 AccessDeviceEndpointKey accessDeviceEndpoint)

Method Details

setUser

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAccessDeviceEndpoint

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setAccessDeviceEndpoint(AccessDeviceEndpointKey accessDeviceEndpoint)

getAccessDeviceEndpoint

public AccessDeviceEndpointKey getAccessDeviceEndpoint()

setIsActive

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setAllowOrigination

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setAllowOrigination(Boolean allowOrigination)

getAllowOrigination

public Boolean getAllowOrigination()

setAllowTermination

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setAllowTermination(Boolean allowTermination)

getAllowTermination

public Boolean getAllowTermination()

setUseHotline

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setUseHotline(Boolean useHotline)

getUseHotline

public Boolean getUseHotline()

unsetHotlineContact

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest unsetHotlineContact()

setHotlineContact

public UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest setHotlineContact(String hotlineContact)

getHotlineContact

public Optional<@Size(min=1,max=161) String> getHotlineContact()

getEmptyObject

public static UserSharedCallAppearance.UserSharedCallAppearanceModifyEndpointRequest 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>