Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemRoutingGetRouteDeviceListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemRoutingGetRouteDeviceListResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemRoutingGetRouteDeviceListRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemRoutingGetRouteDeviceListRequest
extends Request<BWSystem.SystemRoutingGetRouteDeviceListResponse>

Request to get a list of devices for a route. The response is either a SystemRoutingGetRouteDeviceListResponse 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 @Size(min=1,max=32) String	routeName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemRoutingGetRouteDeviceListRequest()
SystemRoutingGetRouteDeviceListRequest(BroadWorksServer broadWorksServer, String routeName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemRoutingGetRouteDeviceListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRouteName()
BWSystem.SystemRoutingGetRouteDeviceListRequest	setRouteName(String routeName)

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

routeName

@NotNull
@Size(min=1,
      max=32)
protected @NotNull @Size(min=1,max=32) String routeName

Constructor Details

SystemRoutingGetRouteDeviceListRequest

public SystemRoutingGetRouteDeviceListRequest()

SystemRoutingGetRouteDeviceListRequest

public SystemRoutingGetRouteDeviceListRequest(BroadWorksServer broadWorksServer,
 String routeName)

Method Details

setRouteName

public BWSystem.SystemRoutingGetRouteDeviceListRequest setRouteName(String routeName)

getRouteName

public String getRouteName()

getEmptyObject

public static BWSystem.SystemRoutingGetRouteDeviceListRequest 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<BWSystem.SystemRoutingGetRouteDeviceListResponse>