Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateRoomListGetRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateRoomListGetRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateRoomListGetRequest
extends Request<CollaborateBridge.UserCollaborateRoomListGetResponse>

Request the list of collaborate room instances for this specific user. The response is either a UserCollaborateRoomListGetResponse or an 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 @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserCollaborateRoomListGetRequest()
UserCollaborateRoomListGetRequest(BroadWorksUser user)

Method Summary

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

Constructor Details

UserCollaborateRoomListGetRequest

public UserCollaborateRoomListGetRequest()

UserCollaborateRoomListGetRequest

public UserCollaborateRoomListGetRequest(BroadWorksUser user)

Method Details

setUser

public CollaborateBridge.UserCollaborateRoomListGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

getEmptyObject

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