Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemNetworkRoutingServerModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemNetworkRoutingServerModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemNetworkRoutingServerModifyRequest
extends Request<DefaultResponse>

Request to modify a routing Network Server in the system. 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 Boolean	poll
protected Optional<Integer>	port
protected TransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemNetworkRoutingServerModifyRequest()
SystemNetworkRoutingServerModifyRequest(BroadWorksServer broadWorksServer, 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.SystemNetworkRoutingServerModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Boolean	getPoll()
Optional<Integer>	getPort()
TransportProtocol	getTransportProtocol()
BWSystem.SystemNetworkRoutingServerModifyRequest	setDescription(String description)
BWSystem.SystemNetworkRoutingServerModifyRequest	setNetAddress(String netAddress)
BWSystem.SystemNetworkRoutingServerModifyRequest	setPoll(Boolean poll)
BWSystem.SystemNetworkRoutingServerModifyRequest	setPort(Integer port)
BWSystem.SystemNetworkRoutingServerModifyRequest	setTransportProtocol(TransportProtocol transportProtocol)
BWSystem.SystemNetworkRoutingServerModifyRequest	unsetDescription()
BWSystem.SystemNetworkRoutingServerModifyRequest	unsetPort()

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

netAddress

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

port

protected Optional<Integer> port

transportProtocol

protected TransportProtocol transportProtocol

poll

protected Boolean poll

description

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

Constructor Details

SystemNetworkRoutingServerModifyRequest

public SystemNetworkRoutingServerModifyRequest()

SystemNetworkRoutingServerModifyRequest

public SystemNetworkRoutingServerModifyRequest(BroadWorksServer broadWorksServer,
 String netAddress)

Method Details

setNetAddress

public BWSystem.SystemNetworkRoutingServerModifyRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

unsetPort

public BWSystem.SystemNetworkRoutingServerModifyRequest unsetPort()

setPort

public BWSystem.SystemNetworkRoutingServerModifyRequest setPort(Integer port)

getPort

public Optional<Integer> getPort()

setTransportProtocol

public BWSystem.SystemNetworkRoutingServerModifyRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

setPoll

public BWSystem.SystemNetworkRoutingServerModifyRequest setPoll(Boolean poll)

getPoll

public Boolean getPoll()

unsetDescription

public BWSystem.SystemNetworkRoutingServerModifyRequest unsetDescription()

setDescription

public BWSystem.SystemNetworkRoutingServerModifyRequest setDescription(String description)

getDescription

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

getEmptyObject

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