Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest
extends Request<SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceResponse>

Requests the tree device linked with the system 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 SystemAccessDeviceGetLinkedTreeDeviceResponse 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 SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceGetLinkedTreeDeviceRequest()
SystemAccessDeviceGetLinkedTreeDeviceRequest(SystemAccessDevice systemAccessDevice)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

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

systemAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid SystemAccessDevice systemAccessDevice

Constructor Details

SystemAccessDeviceGetLinkedTreeDeviceRequest

public SystemAccessDeviceGetLinkedTreeDeviceRequest()

SystemAccessDeviceGetLinkedTreeDeviceRequest

public SystemAccessDeviceGetLinkedTreeDeviceRequest(SystemAccessDevice systemAccessDevice)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

getEmptyObject

public static SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceRequest 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<SystemAccessDevice.SystemAccessDeviceGetLinkedTreeDeviceResponse>