Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateInstantRoomGetRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateInstantRoomGetRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateInstantRoomGetRequest
extends Request<CollaborateBridge.UserCollaborateInstantRoomGetResponse>

Request the collaborate room settings for an instant room. The request fails when requesting collaborate room settings for My Room or project rooms. The response is either UserCollaboratInstantRoomGetResponse 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
UserCollaborateInstantRoomGetRequest()
UserCollaborateInstantRoomGetRequest(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.UserCollaborateInstantRoomGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRoomId()
CollaborateBridge.UserCollaborateInstantRoomGetRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateInstantRoomGetRequest	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

Constructor Details

UserCollaborateInstantRoomGetRequest

public UserCollaborateInstantRoomGetRequest()

UserCollaborateInstantRoomGetRequest

public UserCollaborateInstantRoomGetRequest(BroadWorksUser user,
 String roomId)

Method Details

setUser

public CollaborateBridge.UserCollaborateInstantRoomGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateInstantRoomGetRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

getEmptyObject

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