Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.UserCollaborateRoomIDRegenerateRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.UserCollaborateRoomIDRegenerateRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.UserCollaborateRoomIDRegenerateRequest
extends Request<CollaborateBridge.UserCollaborateRoomIDRegenerateResponse>

Request to regenerate collaborate room id for MyRoom and project room. The request fails when requesting to regenerate room ID for an instant room. The response is either a UserCollaborateRoomIDRegenerateResponse 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 @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
UserCollaborateRoomIDRegenerateRequest()
UserCollaborateRoomIDRegenerateRequest(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.UserCollaborateRoomIDRegenerateRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRoomId()
CollaborateBridge.UserCollaborateRoomIDRegenerateRequest	setRoomId(String roomId)
CollaborateBridge.UserCollaborateRoomIDRegenerateRequest	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

UserCollaborateRoomIDRegenerateRequest

public UserCollaborateRoomIDRegenerateRequest()

UserCollaborateRoomIDRegenerateRequest

public UserCollaborateRoomIDRegenerateRequest(BroadWorksUser user,
 String roomId)

Method Details

setUser

public CollaborateBridge.UserCollaborateRoomIDRegenerateRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setRoomId

public CollaborateBridge.UserCollaborateRoomIDRegenerateRequest setRoomId(String roomId)

getRoomId

public String getRoomId()

getEmptyObject

public static CollaborateBridge.UserCollaborateRoomIDRegenerateRequest 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.UserCollaborateRoomIDRegenerateResponse>