Package co.ecg.alpaca.toolkit.generated

Class User.PlaceModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.PlaceModifyRequest

Enclosing class:

User

public static class User.PlaceModifyRequest
extends Request<DefaultResponse>

Request to configure a WebEx room/place to have the primary endpoint of WebEx Teams device. placeUserId refers to a WebEx room/place. webExSIPAddress specifies the WebEx SIP address of the place. The format of this parameter is: user@domain. The user part specified in webExSIPAddress will be set to the lineport of the place’s primary endpoint. The endpoint will have a static address with URI set to "sip:user@domain". The domain specified in webExSIPAddress will be: - added to the system if it does not exist yet. - assigned to the service provider/enterprise which the place belongs to, if it has not been assigned yet. - assigned to the group which the place belongs to, if it has not been assigned yet. The response is either SuccessResponse 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 @NotNull @Size(min=1,max=161) String	placeUserId
protected @Size(min=1,max=161) String	webExSIPAddress

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

log

Constructor Summary

Constructors

Constructor	Description
PlaceModifyRequest()
PlaceModifyRequest(BroadWorksServer broadWorksServer, String placeUserId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static User.PlaceModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getPlaceUserId()
String	getWebExSIPAddress()
User.PlaceModifyRequest	setPlaceUserId(String placeUserId)
User.PlaceModifyRequest	setWebExSIPAddress(String webExSIPAddress)

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

placeUserId

@NotNull
@Size(min=1,
      max=161)
protected @NotNull @Size(min=1,max=161) String placeUserId

webExSIPAddress

@Size(min=1,
      max=161)
protected @Size(min=1,max=161) String webExSIPAddress

Constructor Details

PlaceModifyRequest

public PlaceModifyRequest()

PlaceModifyRequest

public PlaceModifyRequest(BroadWorksServer broadWorksServer,
 String placeUserId)

Method Details

setPlaceUserId

public User.PlaceModifyRequest setPlaceUserId(String placeUserId)

getPlaceUserId

public String getPlaceUserId()

setWebExSIPAddress

public User.PlaceModifyRequest setWebExSIPAddress(String webExSIPAddress)

getWebExSIPAddress

public String getWebExSIPAddress()

getEmptyObject

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