Package co.ecg.alpaca.toolkit.generated

Class Group.GroupGetAvailableLeafDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupGetAvailableLeafDeviceListResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupGetAvailableLeafDeviceListRequest

Enclosing class:

Group

public static class Group.GroupGetAvailableLeafDeviceListRequest
extends Request<Group.GroupGetAvailableLeafDeviceListResponse>

Requests the list of available leaf devices that can be linked to a tree device within a specific group. 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 GroupGetAvailableLeafDeviceListResponse22 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 Group	group
protected LeafDeviceCategory	leafDeviceCategory

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

log

Constructor Summary

Constructors

Constructor	Description
GroupGetAvailableLeafDeviceListRequest()
GroupGetAvailableLeafDeviceListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Group.GroupGetAvailableLeafDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
LeafDeviceCategory	getLeafDeviceCategory()
Group.GroupGetAvailableLeafDeviceListRequest	setGroup(Group group)
Group.GroupGetAvailableLeafDeviceListRequest	setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

leafDeviceCategory

protected LeafDeviceCategory leafDeviceCategory

Constructor Details

GroupGetAvailableLeafDeviceListRequest

public GroupGetAvailableLeafDeviceListRequest()

GroupGetAvailableLeafDeviceListRequest

public GroupGetAvailableLeafDeviceListRequest(Group group)

Method Details

setGroup

public Group.GroupGetAvailableLeafDeviceListRequest setGroup(Group group)

getGroup

public Group getGroup()

setLeafDeviceCategory

public Group.GroupGetAvailableLeafDeviceListRequest setLeafDeviceCategory(LeafDeviceCategory leafDeviceCategory)

getLeafDeviceCategory

public LeafDeviceCategory getLeafDeviceCategory()

getEmptyObject

public static Group.GroupGetAvailableLeafDeviceListRequest 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<Group.GroupGetAvailableLeafDeviceListResponse>