Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemRoutingAddRouteDeviceRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemRoutingAddRouteDeviceRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemRoutingAddRouteDeviceRequest
extends Request<DefaultResponse>

Request to add a routing device to a route. The response is either a SuccessResponse 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 @Size(min=1,max=80) String	description
protected @NotNull @Size(min=1,max=80) String	netAddress
protected Integer	port
protected @NotNull @Size(min=1,max=32) String	routeName
protected @NotNull ExtendedTransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemRoutingAddRouteDeviceRequest()
SystemRoutingAddRouteDeviceRequest(BroadWorksServer broadWorksServer, String routeName, String netAddress, ExtendedTransportProtocol transportProtocol)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemRoutingAddRouteDeviceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Integer	getPort()
String	getRouteName()
ExtendedTransportProtocol	getTransportProtocol()
BWSystem.SystemRoutingAddRouteDeviceRequest	setDescription(String description)
BWSystem.SystemRoutingAddRouteDeviceRequest	setNetAddress(String netAddress)
BWSystem.SystemRoutingAddRouteDeviceRequest	setPort(Integer port)
BWSystem.SystemRoutingAddRouteDeviceRequest	setRouteName(String routeName)
BWSystem.SystemRoutingAddRouteDeviceRequest	setTransportProtocol(ExtendedTransportProtocol transportProtocol)

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

netAddress

@NotNull
@Size(min=1,
      max=80)
protected @NotNull @Size(min=1,max=80) String netAddress

port

protected Integer port

transportProtocol

@NotNull
protected @NotNull ExtendedTransportProtocol transportProtocol

description

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String description

Constructor Details

SystemRoutingAddRouteDeviceRequest

public SystemRoutingAddRouteDeviceRequest()

SystemRoutingAddRouteDeviceRequest

public SystemRoutingAddRouteDeviceRequest(BroadWorksServer broadWorksServer,
 String routeName,
 String netAddress,
 ExtendedTransportProtocol transportProtocol)

Method Details

setRouteName

public BWSystem.SystemRoutingAddRouteDeviceRequest setRouteName(String routeName)

getRouteName

public String getRouteName()

setNetAddress

public BWSystem.SystemRoutingAddRouteDeviceRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public BWSystem.SystemRoutingAddRouteDeviceRequest setPort(Integer port)

getPort

public Integer getPort()

setTransportProtocol

public BWSystem.SystemRoutingAddRouteDeviceRequest setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setDescription

public BWSystem.SystemRoutingAddRouteDeviceRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

public static BWSystem.SystemRoutingAddRouteDeviceRequest 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<DefaultResponse>