Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateInstantRoomAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateInstantRoomAddRequest

Enclosing class:

CollaborateBridge

@ChoiceGroup("roomName") @ChoiceGroup("useRoomIdAsRoomName")
public static class CollaborateBridge.UserCollaborateInstantRoomAddRequest
extends Request<CollaborateBridge.UserCollaborateInstantRoomAddResponse>

Request to add collaborate instant room. The response is either a UserCollaborateInstantRoomAddResponse 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 @Size(min=1,max=40) String	roomName
protected @NotNull @Valid BroadWorksUser	user
protected @AssertTrue Boolean	useRoomIdAsRoomName

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

log

Constructor Summary

Constructors

Constructor	Description
UserCollaborateInstantRoomAddRequest()
UserCollaborateInstantRoomAddRequest(BroadWorksUser user)
UserCollaborateInstantRoomAddRequest(Boolean useRoomIdAsRoomName, BroadWorksUser user)
UserCollaborateInstantRoomAddRequest(String roomName, BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static CollaborateBridge.UserCollaborateInstantRoomAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRoomName()
Boolean	getUseRoomIdAsRoomName()
CollaborateBridge.UserCollaborateInstantRoomAddRequest	setFlagUseRoomIdAsRoomName()
CollaborateBridge.UserCollaborateInstantRoomAddRequest	setRoomName(String roomName)
CollaborateBridge.UserCollaborateInstantRoomAddRequest	setUser(BroadWorksUser user)
boolean	useRoomIdAsRoomNameFlagExist()

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

roomName

@Size(min=1,
      max=40)
protected @Size(min=1,max=40) String roomName

useRoomIdAsRoomName

@AssertTrue
protected @AssertTrue Boolean useRoomIdAsRoomName

Constructor Details

UserCollaborateInstantRoomAddRequest

public UserCollaborateInstantRoomAddRequest()

UserCollaborateInstantRoomAddRequest

public UserCollaborateInstantRoomAddRequest(BroadWorksUser user)

UserCollaborateInstantRoomAddRequest

public UserCollaborateInstantRoomAddRequest(String roomName,
 BroadWorksUser user)

UserCollaborateInstantRoomAddRequest

public UserCollaborateInstantRoomAddRequest(Boolean useRoomIdAsRoomName,
 BroadWorksUser user)

Method Details

setUser

public CollaborateBridge.UserCollaborateInstantRoomAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomName

public CollaborateBridge.UserCollaborateInstantRoomAddRequest setRoomName(String roomName)

getRoomName

public String getRoomName()

setFlagUseRoomIdAsRoomName

public CollaborateBridge.UserCollaborateInstantRoomAddRequest setFlagUseRoomIdAsRoomName()

useRoomIdAsRoomNameFlagExist

public boolean useRoomIdAsRoomNameFlagExist()

getUseRoomIdAsRoomName

public Boolean getUseRoomIdAsRoomName()

getEmptyObject

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