Package co.ecg.alpaca.toolkit.generated

Class GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest

Enclosing class:

GroupAccessDevice

public static class GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest
extends Request<GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListResponse>

Requests the list of linked leaf devices for the group level tree 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". It can be linked to only one tree device. The list includes devices created at the system, service provider, and group levels. The response is either GroupAccessDeviceGetLinkedLeafDeviceListResponse 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
GroupAccessDeviceGetLinkedLeafDeviceListRequest()
GroupAccessDeviceGetLinkedLeafDeviceListRequest(GroupAccessDevice groupAccessDevice)

Method Summary

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

GroupAccessDeviceGetLinkedLeafDeviceListRequest

public GroupAccessDeviceGetLinkedLeafDeviceListRequest()

GroupAccessDeviceGetLinkedLeafDeviceListRequest

public GroupAccessDeviceGetLinkedLeafDeviceListRequest(GroupAccessDevice groupAccessDevice)

Method Details

setGroupAccessDevice

public GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest setGroupAccessDevice(GroupAccessDevice groupAccessDevice)

getGroupAccessDevice

public GroupAccessDevice getGroupAccessDevice()

getEmptyObject

public static GroupAccessDevice.GroupAccessDeviceGetLinkedLeafDeviceListRequest 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.GroupAccessDeviceGetLinkedLeafDeviceListResponse>