Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceResponse>

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest

Enclosing class:

GroupAccessDevice

public static class GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest
extends Request<GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceResponse>

Requests the tree device linked with the group level leaf device passed in the request. 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. A leaf device is a device associated with a device type that has the option supportLinks set to "Support Link to Device" or "Support Link to Device and User". It can be linked to only one tree device. The response is either GroupAccessDeviceGetLinkedTreeDeviceResponse 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 GroupAccessDevice	groupAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAccessDeviceGetLinkedTreeDeviceRequest()
GroupAccessDeviceGetLinkedTreeDeviceRequest(GroupAccessDevice groupAccessDevice)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
GroupAccessDevice	getGroupAccessDevice()
GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest	setGroupAccessDevice(GroupAccessDevice groupAccessDevice)

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

groupAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid GroupAccessDevice groupAccessDevice

Constructor Details

GroupAccessDeviceGetLinkedTreeDeviceRequest

public GroupAccessDeviceGetLinkedTreeDeviceRequest()

GroupAccessDeviceGetLinkedTreeDeviceRequest

public GroupAccessDeviceGetLinkedTreeDeviceRequest(GroupAccessDevice groupAccessDevice)

Method Details

setGroupAccessDevice

public GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest setGroupAccessDevice(GroupAccessDevice groupAccessDevice)

getGroupAccessDevice

public GroupAccessDevice getGroupAccessDevice()

getEmptyObject

public static GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceRequest 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<GroupAccessDevice.GroupAccessDeviceGetLinkedTreeDeviceResponse>