Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateProjectRoomModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateProjectRoomModifyRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateProjectRoomModifyRequest
extends Request<DefaultResponse>

Request to modify collaborate room settings for a project room. The request fails when modifying collaborate room settings for instant rooms or My Room. 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
UserCollaborateProjectRoomModifyRequest()
UserCollaborateProjectRoomModifyRequest(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.UserCollaborateProjectRoomModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEndCollaborateRoomSessionOnOwnerExit()
Boolean	getOwnerRequired()
String	getRoomId()
String	getRoomName()
ConferenceSchedule	getRoomSchedule()
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setAttendeeNotification(CollaborateRoomAttendeeNotification attendeeNotification)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setEndCollaborateRoomSessionOnOwnerExit(Boolean endCollaborateRoomSessionOnOwnerExit)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setOwnerRequired(Boolean ownerRequired)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setRoomName(String roomName)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	setRoomSchedule(ConferenceSchedule roomSchedule)
CollaborateBridge.UserCollaborateProjectRoomModifyRequest	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

UserCollaborateProjectRoomModifyRequest

public UserCollaborateProjectRoomModifyRequest()

UserCollaborateProjectRoomModifyRequest

public UserCollaborateProjectRoomModifyRequest(BroadWorksUser user,
 String roomId)

Method Details

setUser

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

setRoomName

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setRoomName(String roomName)

getRoomName

public String getRoomName()

setAttendeeNotification

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setAttendeeNotification(CollaborateRoomAttendeeNotification attendeeNotification)

getAttendeeNotification

public CollaborateRoomAttendeeNotification getAttendeeNotification()

setEndCollaborateRoomSessionOnOwnerExit

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setEndCollaborateRoomSessionOnOwnerExit(Boolean endCollaborateRoomSessionOnOwnerExit)

getEndCollaborateRoomSessionOnOwnerExit

public Boolean getEndCollaborateRoomSessionOnOwnerExit()

setOwnerRequired

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setOwnerRequired(Boolean ownerRequired)

getOwnerRequired

public Boolean getOwnerRequired()

setRoomSchedule

public CollaborateBridge.UserCollaborateProjectRoomModifyRequest setRoomSchedule(ConferenceSchedule roomSchedule)

getRoomSchedule

public ConferenceSchedule getRoomSchedule()

getEmptyObject

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