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

Class UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest

java.lang.Object

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

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

Enclosing class:

UserSharedCallAppearance

public static class UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest
extends Request<DefaultResponse>

Associate an access device instance to the user's Shared Call Appearance. The following elements are ignored in XS data mode: allowVideo, useValue true in AS data mode 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 AccessDeviceEndpointAndHotlineAdd	accessDeviceEndpoint
protected @NotNull Boolean	allowOrigination
protected @NotNull Boolean	allowTermination
protected @NotNull Boolean	allowVideo
protected @NotNull Boolean	isActive
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserSharedCallAppearanceAddEndpointRequest()
UserSharedCallAppearanceAddEndpointRequest(BroadWorksUser user, AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint, Boolean isActive, Boolean allowOrigination, Boolean allowTermination, Boolean allowVideo)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AccessDeviceEndpointAndHotlineAdd	getAccessDeviceEndpoint()
Boolean	getAllowOrigination()
Boolean	getAllowTermination()
Boolean	getAllowVideo()
BroadWorksUser	getBroadWorksUser()
static UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIsActive()
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	setAccessDeviceEndpoint(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint)
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	setAllowOrigination(Boolean allowOrigination)
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	setAllowTermination(Boolean allowTermination)
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	setAllowVideo(Boolean allowVideo)
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	setIsActive(Boolean isActive)
UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest	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 Detail

user

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

accessDeviceEndpoint

@NotNull
@Valid
protected @NotNull @Valid AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint

isActive

@NotNull
protected @NotNull Boolean isActive

allowOrigination

@NotNull
protected @NotNull Boolean allowOrigination

allowTermination

@NotNull
protected @NotNull Boolean allowTermination

allowVideo

@NotNull
protected @NotNull Boolean allowVideo

Constructor Detail

UserSharedCallAppearanceAddEndpointRequest

public UserSharedCallAppearanceAddEndpointRequest()

UserSharedCallAppearanceAddEndpointRequest

public UserSharedCallAppearanceAddEndpointRequest(BroadWorksUser user,
                                                  AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint,
                                                  Boolean isActive,
                                                  Boolean allowOrigination,
                                                  Boolean allowTermination,
                                                  Boolean allowVideo)

Method Detail

setUser

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAccessDeviceEndpoint

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setAccessDeviceEndpoint(AccessDeviceEndpointAndHotlineAdd accessDeviceEndpoint)

getAccessDeviceEndpoint

public AccessDeviceEndpointAndHotlineAdd getAccessDeviceEndpoint()

setIsActive

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setIsActive(Boolean isActive)

getIsActive

public Boolean getIsActive()

setAllowOrigination

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setAllowOrigination(Boolean allowOrigination)

getAllowOrigination

public Boolean getAllowOrigination()

setAllowTermination

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setAllowTermination(Boolean allowTermination)

getAllowTermination

public Boolean getAllowTermination()

setAllowVideo

public UserSharedCallAppearance.UserSharedCallAppearanceAddEndpointRequest setAllowVideo(Boolean allowVideo)

getAllowVideo

public Boolean getAllowVideo()

getEmptyObject

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