Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateProjectRoomGetRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateProjectRoomGetRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateProjectRoomGetRequest
extends Request<CollaborateBridge.UserCollaborateProjectRoomGetResponse>

Request collaborate room settings for a project room. The request fails when requesting collaborate room settings for instant rooms or My Room. The response is either UserCollaboratProjectRoomGetResponse 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
UserCollaborateProjectRoomGetRequest()
UserCollaborateProjectRoomGetRequest(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.UserCollaborateProjectRoomGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRoomId()
CollaborateBridge.UserCollaborateProjectRoomGetRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateProjectRoomGetRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

UserCollaborateProjectRoomGetRequest

public UserCollaborateProjectRoomGetRequest()

UserCollaborateProjectRoomGetRequest

public UserCollaborateProjectRoomGetRequest(BroadWorksUser user,
                                            String roomId)

Method Detail

setUser

public CollaborateBridge.UserCollaborateProjectRoomGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateProjectRoomGetRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

getEmptyObject

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