Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateRoomGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<CollaborateBridge.UserCollaborateRoomGetResponse>

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateRoomGetRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateRoomGetRequest
extends Request<CollaborateBridge.UserCollaborateRoomGetResponse>

Request to get the settings for My Room, Instant Room or Project Room. The roomType and roomName parameters are returned for all rooms. For My room and Project Room, the following parameters are returned: attendeeNotification, endRoomSessionOnOwnerExit and ownerRequired. In addition, the roomSchedule is returned for Project Room and the roomStartTime and roomEndTime are returned for Instant Room. The response is either UserCollaboratetRoomGetResponse 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=4,max=15) String	roomId
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static CollaborateBridge.UserCollaborateRoomGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRoomId()
CollaborateBridge.UserCollaborateRoomGetRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateRoomGetRequest	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

roomId

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

Constructor Detail

UserCollaborateRoomGetRequest

public UserCollaborateRoomGetRequest()

UserCollaborateRoomGetRequest

public UserCollaborateRoomGetRequest(BroadWorksUser user,
                                     String roomId)

Method Detail

setUser

public CollaborateBridge.UserCollaborateRoomGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateRoomGetRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

getEmptyObject

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