Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest
extends Request<DefaultResponse>

Request to link one or more leaf devices to a system level tree device. 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 response is either a SuccessResponse or an 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 @Size(min=1) AccessDeviceKey[]	leafDeviceKey
protected @NotNull @Valid SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceLinkDeviceListRequest()
SystemAccessDeviceLinkDeviceListRequest(SystemAccessDevice systemAccessDevice, AccessDeviceKey... leafDeviceKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
AccessDeviceKey[]	getLeafDeviceKey()
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest	setLeafDeviceKey(AccessDeviceKey... leafDeviceKey)
SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest	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

leafDeviceKey

@NotNull
@Valid
@Size(min=1)
protected @NotNull @Valid @Size(min=1) AccessDeviceKey[] leafDeviceKey

Constructor Details

SystemAccessDeviceLinkDeviceListRequest

public SystemAccessDeviceLinkDeviceListRequest()

SystemAccessDeviceLinkDeviceListRequest

public SystemAccessDeviceLinkDeviceListRequest(SystemAccessDevice systemAccessDevice,
 AccessDeviceKey... leafDeviceKey)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setLeafDeviceKey

public SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest setLeafDeviceKey(AccessDeviceKey... leafDeviceKey)

getLeafDeviceKey

public AccessDeviceKey[] getLeafDeviceKey()

getEmptyObject

public static SystemAccessDevice.SystemAccessDeviceLinkDeviceListRequest 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<DefaultResponse>