Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemRoutingModifyRouteDeviceRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemRoutingModifyRouteDeviceRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemRoutingModifyRouteDeviceRequest
extends Request<DefaultResponse>

Request to modify a routing device. 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 Optional<@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 TransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemRoutingModifyRouteDeviceRequest()
SystemRoutingModifyRouteDeviceRequest(BroadWorksServer broadWorksServer, String routeName, String netAddress)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemRoutingModifyRouteDeviceRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Integer	getPort()
String	getRouteName()
TransportProtocol	getTransportProtocol()
BWSystem.SystemRoutingModifyRouteDeviceRequest	setDescription(String description)
BWSystem.SystemRoutingModifyRouteDeviceRequest	setNetAddress(String netAddress)
BWSystem.SystemRoutingModifyRouteDeviceRequest	setPort(Integer port)
BWSystem.SystemRoutingModifyRouteDeviceRequest	setRouteName(String routeName)
BWSystem.SystemRoutingModifyRouteDeviceRequest	setTransportProtocol(TransportProtocol transportProtocol)
BWSystem.SystemRoutingModifyRouteDeviceRequest	unsetDescription()

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

protected TransportProtocol transportProtocol

description

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

Constructor Details

SystemRoutingModifyRouteDeviceRequest

public SystemRoutingModifyRouteDeviceRequest()

SystemRoutingModifyRouteDeviceRequest

public SystemRoutingModifyRouteDeviceRequest(BroadWorksServer broadWorksServer,
 String routeName,
 String netAddress)

Method Details

setRouteName

public BWSystem.SystemRoutingModifyRouteDeviceRequest setRouteName(String routeName)

getRouteName

public String getRouteName()

setNetAddress

public BWSystem.SystemRoutingModifyRouteDeviceRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public BWSystem.SystemRoutingModifyRouteDeviceRequest setPort(Integer port)

getPort

public Integer getPort()

setTransportProtocol

public BWSystem.SystemRoutingModifyRouteDeviceRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

unsetDescription

public BWSystem.SystemRoutingModifyRouteDeviceRequest unsetDescription()

setDescription

public BWSystem.SystemRoutingModifyRouteDeviceRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

getEmptyObject

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