Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest
extends Request<SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListResponse>

Requests the list of linked leaf devices for the system level tree device passed in the request. 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" or "Support Link to Device and User". It can be linked to only one tree device. The list 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 SystemAccessDeviceGetLinkedLeafDeviceListResponse22 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 SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceGetLinkedLeafDeviceListRequest()
SystemAccessDeviceGetLinkedLeafDeviceListRequest(SystemAccessDevice systemAccessDevice)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
LeafDeviceCategory	getLeafDeviceCategory()
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest	setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)
SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

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

systemAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid SystemAccessDevice systemAccessDevice

leafDeviceCategory

protected LeafDeviceCategory leafDeviceCategory

Constructor Details

SystemAccessDeviceGetLinkedLeafDeviceListRequest

public SystemAccessDeviceGetLinkedLeafDeviceListRequest()

SystemAccessDeviceGetLinkedLeafDeviceListRequest

public SystemAccessDeviceGetLinkedLeafDeviceListRequest(SystemAccessDevice systemAccessDevice)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setLeafDeviceCategory

public SystemAccessDevice.SystemAccessDeviceGetLinkedLeafDeviceListRequest setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)

getLeafDeviceCategory

public LeafDeviceCategory getLeafDeviceCategory()

getEmptyObject

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