Package co.ecg.alpaca.toolkit.generated

Class CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest

Enclosing class:

CollaborateBridge

public static class CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest
extends Request<CollaborateBridge.GroupCollaborateBridgeGetInstanceListResponse>

Get a list of collaborate bridges within a group. The response is either GroupCollaborateBridgeGetInstanceListResponse or ErrorResponse. It is possible to get the instances within a specified department.

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=50) String	departmentName
protected @NotNull @Valid Group	group

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCollaborateBridgeGetInstanceListRequest()
GroupCollaborateBridgeGetInstanceListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDepartmentName()
static CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest	setDepartmentName(String departmentName)
CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest	setGroup(Group group)

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

departmentName

@Size(min=1,
      max=50)
protected @Size(min=1,max=50) String departmentName

Constructor Details

GroupCollaborateBridgeGetInstanceListRequest

public GroupCollaborateBridgeGetInstanceListRequest()

GroupCollaborateBridgeGetInstanceListRequest

public GroupCollaborateBridgeGetInstanceListRequest(Group group)

Method Details

setGroup

public CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest setGroup(Group group)

getGroup

public Group getGroup()

setDepartmentName

public CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest setDepartmentName(String departmentName)

getDepartmentName

public String getDepartmentName()

getEmptyObject

public static CollaborateBridge.GroupCollaborateBridgeGetInstanceListRequest 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.GroupCollaborateBridgeGetInstanceListResponse>