Package co.ecg.alpaca.toolkit.generated

Class Group.GroupGetAvailableTreeDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupGetAvailableTreeDeviceListResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupGetAvailableTreeDeviceListRequest

Enclosing class:

Group

public static class Group.GroupGetAvailableTreeDeviceListRequest
extends Request<Group.GroupGetAvailableTreeDeviceListResponse>

Requests the list of available tree devices to which leaf devices can be linked to within a specific group. A tree device is a device associated with a device type that has the option supportLinks set to "Support Links from Devices". Many leaf devices can be linked to it. The list returned includes devices created at the system, service provider, and group levels. The response is either GroupGetAvailableTreeDeviceListResponse 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 @Valid Group	group

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

log

Constructor Summary

Constructors

Constructor	Description
GroupGetAvailableTreeDeviceListRequest()
GroupGetAvailableTreeDeviceListRequest(Group group)

Method Summary

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

Constructor Details

GroupGetAvailableTreeDeviceListRequest

public GroupGetAvailableTreeDeviceListRequest()

GroupGetAvailableTreeDeviceListRequest

public GroupGetAvailableTreeDeviceListRequest(Group group)

Method Details

setGroup

public Group.GroupGetAvailableTreeDeviceListRequest setGroup(Group group)

getGroup

public Group getGroup()

getEmptyObject

public static Group.GroupGetAvailableTreeDeviceListRequest 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<Group.GroupGetAvailableTreeDeviceListResponse>