Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateRoomModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateRoomModifyRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateRoomModifyRequest
extends Request<DefaultResponse>

Request to modify room settings for a specific Project Room or My Room. Request to modify room settings for a specific Instant Room is responded with an ErrorResponse. The roomSchedule parameter is applicable for Project Room only. If the roomSchedule parameter is specified in the request to modify My Room, the request will be failed. 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 CollaborateRoomAttendeeNotification	attendeeNotification
protected Boolean	endCollaborateRoomSessionOnOwnerExit
protected Boolean	ownerRequired
protected @NotNull @Size(min=4,max=15) String	roomId
protected @Size(min=1,max=40) String	roomName
protected @Valid ConferenceSchedule	roomSchedule
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserCollaborateRoomModifyRequest()
UserCollaborateRoomModifyRequest(BroadWorksUser user, String roomId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
CollaborateRoomAttendeeNotification	getAttendeeNotification()
BroadWorksUser	getBroadWorksUser()
static CollaborateBridge.UserCollaborateRoomModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEndCollaborateRoomSessionOnOwnerExit()
Boolean	getOwnerRequired()
String	getRoomId()
String	getRoomName()
ConferenceSchedule	getRoomSchedule()
CollaborateBridge.UserCollaborateRoomModifyRequest	setAttendeeNotification(CollaborateRoomAttendeeNotification attendeeNotification)
CollaborateBridge.UserCollaborateRoomModifyRequest	setEndCollaborateRoomSessionOnOwnerExit(Boolean endCollaborateRoomSessionOnOwnerExit)
CollaborateBridge.UserCollaborateRoomModifyRequest	setOwnerRequired(Boolean ownerRequired)
CollaborateBridge.UserCollaborateRoomModifyRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateRoomModifyRequest	setRoomName(String roomName)
CollaborateBridge.UserCollaborateRoomModifyRequest	setRoomSchedule(ConferenceSchedule roomSchedule)
CollaborateBridge.UserCollaborateRoomModifyRequest	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

roomId

@NotNull
@Size(min=4,
      max=15)
protected @NotNull @Size(min=4,max=15) String roomId

roomName

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String roomName

attendeeNotification

protected CollaborateRoomAttendeeNotification attendeeNotification

endCollaborateRoomSessionOnOwnerExit

protected Boolean endCollaborateRoomSessionOnOwnerExit

ownerRequired

protected Boolean ownerRequired

roomSchedule

@Valid
protected @Valid ConferenceSchedule roomSchedule

Constructor Details

UserCollaborateRoomModifyRequest

public UserCollaborateRoomModifyRequest()

UserCollaborateRoomModifyRequest

public UserCollaborateRoomModifyRequest(BroadWorksUser user,
 String roomId)

Method Details

setUser

public CollaborateBridge.UserCollaborateRoomModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateRoomModifyRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

setRoomName

public CollaborateBridge.UserCollaborateRoomModifyRequest setRoomName(String roomName)

getRoomName

public String getRoomName()

setAttendeeNotification

public CollaborateBridge.UserCollaborateRoomModifyRequest setAttendeeNotification(CollaborateRoomAttendeeNotification attendeeNotification)

getAttendeeNotification

public CollaborateRoomAttendeeNotification getAttendeeNotification()

setEndCollaborateRoomSessionOnOwnerExit

public CollaborateBridge.UserCollaborateRoomModifyRequest setEndCollaborateRoomSessionOnOwnerExit(Boolean endCollaborateRoomSessionOnOwnerExit)

getEndCollaborateRoomSessionOnOwnerExit

public Boolean getEndCollaborateRoomSessionOnOwnerExit()

setOwnerRequired

public CollaborateBridge.UserCollaborateRoomModifyRequest setOwnerRequired(Boolean ownerRequired)

getOwnerRequired

public Boolean getOwnerRequired()

setRoomSchedule

public CollaborateBridge.UserCollaborateRoomModifyRequest setRoomSchedule(ConferenceSchedule roomSchedule)

getRoomSchedule

public ConferenceSchedule getRoomSchedule()

getEmptyObject

public static CollaborateBridge.UserCollaborateRoomModifyRequest 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>