Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceLinkDeviceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceLinkDeviceListRequest

Enclosing class:

ServiceProviderAccessDevice

public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceLinkDeviceListRequest
extends Request<DefaultResponse>

Request to link one or more leaf devices to a service provider 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 ServiceProviderAccessDevice	serviceProviderAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderAccessDeviceLinkDeviceListRequest()
ServiceProviderAccessDeviceLinkDeviceListRequest(ServiceProviderAccessDevice serviceProviderAccessDevice, AccessDeviceKey... leafDeviceKey)

Method Summary

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

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

serviceProviderAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProviderAccessDevice serviceProviderAccessDevice

leafDeviceKey

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

Constructor Details

ServiceProviderAccessDeviceLinkDeviceListRequest

public ServiceProviderAccessDeviceLinkDeviceListRequest()

ServiceProviderAccessDeviceLinkDeviceListRequest

public ServiceProviderAccessDeviceLinkDeviceListRequest(ServiceProviderAccessDevice serviceProviderAccessDevice,
 AccessDeviceKey... leafDeviceKey)

Method Details

setServiceProviderAccessDevice

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceLinkDeviceListRequest setServiceProviderAccessDevice(ServiceProviderAccessDevice serviceProviderAccessDevice)

getServiceProviderAccessDevice

public ServiceProviderAccessDevice getServiceProviderAccessDevice()

setLeafDeviceKey

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

getLeafDeviceKey

public AccessDeviceKey[] getLeafDeviceKey()

getEmptyObject

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