Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<ServiceProvider.ServiceProviderGetAvailableTreeDeviceListResponse>

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest
extends Request<ServiceProvider.ServiceProviderGetAvailableTreeDeviceListResponse>

Requests the list of available tree devices to which a leaf device can be linked to within a specific service provider. 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. The list returned includes devices created at the system, service provider, and group levels. The response is either ServiceProviderGetAvailableTreeDeviceListResponse 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 ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderGetAvailableTreeDeviceListRequest()
ServiceProviderGetAvailableTreeDeviceListRequest(ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest	setServiceProvider(ServiceProvider serviceProvider)

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

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

Constructor Details

ServiceProviderGetAvailableTreeDeviceListRequest

public ServiceProviderGetAvailableTreeDeviceListRequest()

ServiceProviderGetAvailableTreeDeviceListRequest

public ServiceProviderGetAvailableTreeDeviceListRequest(ServiceProvider serviceProvider)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

getEmptyObject

public static ServiceProvider.ServiceProviderGetAvailableTreeDeviceListRequest 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<ServiceProvider.ServiceProviderGetAvailableTreeDeviceListResponse>