Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest
extends Request<DefaultResponse>

Request to unlink one or more leaf access devices from a tree device. 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 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

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceUnlinkDeviceListRequest()
SystemAccessDeviceUnlinkDeviceListRequest(BroadWorksServer broadWorksServer, AccessDeviceKey... leafDeviceKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
AccessDeviceKey[]	getLeafDeviceKey()
SystemAccessDevice.SystemAccessDeviceUnlinkDeviceListRequest	setLeafDeviceKey(AccessDeviceKey... leafDeviceKey)

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

leafDeviceKey

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

Constructor Details

SystemAccessDeviceUnlinkDeviceListRequest

public SystemAccessDeviceUnlinkDeviceListRequest()

SystemAccessDeviceUnlinkDeviceListRequest

public SystemAccessDeviceUnlinkDeviceListRequest(BroadWorksServer broadWorksServer,
 AccessDeviceKey... leafDeviceKey)

Method Details

setLeafDeviceKey

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

getLeafDeviceKey

public AccessDeviceKey[] getLeafDeviceKey()

getEmptyObject

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