Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest

Enclosing class:

ServiceProviderAccessDevice

public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest
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". 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
ServiceProviderAccessDeviceUnlinkDeviceListRequest()
ServiceProviderAccessDeviceUnlinkDeviceListRequest(BroadWorksServer broadWorksServer, AccessDeviceKey... leafDeviceKey)

Method Summary

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

ServiceProviderAccessDeviceUnlinkDeviceListRequest

public ServiceProviderAccessDeviceUnlinkDeviceListRequest()

ServiceProviderAccessDeviceUnlinkDeviceListRequest

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

Method Details

setLeafDeviceKey

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest setLeafDeviceKey(AccessDeviceKey... leafDeviceKey)

getLeafDeviceKey

public AccessDeviceKey[] getLeafDeviceKey()

getEmptyObject

public static ServiceProviderAccessDevice.ServiceProviderAccessDeviceUnlinkDeviceListRequest 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>