Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest
extends Request<ServiceProvider.ServiceProviderGetAvailableLeafDeviceListResponse>

Requests the list of available leaf devices that can be linked to a tree device within a specific service provider. 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 list returned includes devices created at the system, service provider, and group levels. If the leafDeviceCategory is not set in the request, then linked leaf devices of all categories are requested, otherwise only the linked leaf devices of the specified category are requested. The category values are: "Handset", "Base Station", "All". The response is either ServiceProviderGetAvailableLeafDeviceListResponse22 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 LeafDeviceCategory	leafDeviceCategory
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderGetAvailableLeafDeviceListRequest()
ServiceProviderGetAvailableLeafDeviceListRequest(ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LeafDeviceCategory	getLeafDeviceCategory()
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest	setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)
ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest	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

leafDeviceCategory

protected LeafDeviceCategory leafDeviceCategory

Constructor Details

ServiceProviderGetAvailableLeafDeviceListRequest

public ServiceProviderGetAvailableLeafDeviceListRequest()

ServiceProviderGetAvailableLeafDeviceListRequest

public ServiceProviderGetAvailableLeafDeviceListRequest(ServiceProvider serviceProvider)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setLeafDeviceCategory

public ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)

getLeafDeviceCategory

public LeafDeviceCategory getLeafDeviceCategory()

getEmptyObject

public static ServiceProvider.ServiceProviderGetAvailableLeafDeviceListRequest 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.ServiceProviderGetAvailableLeafDeviceListResponse>