Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemNetworkRoutingServerAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemNetworkRoutingServerAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemNetworkRoutingServerAddRequest
extends Request<DefaultResponse>

Request to add a routing Network Server to 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 @Size(min=1,max=80) String	description
protected @NotNull @Size(min=1,max=80) String	netAddress
protected @NotNull Boolean	poll
protected Integer	port
protected @NotNull TransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemNetworkRoutingServerAddRequest()
SystemNetworkRoutingServerAddRequest(BroadWorksServer broadWorksServer, String netAddress, TransportProtocol transportProtocol, Boolean poll)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
static BWSystem.SystemNetworkRoutingServerAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Boolean	getPoll()
Integer	getPort()
TransportProtocol	getTransportProtocol()
BWSystem.SystemNetworkRoutingServerAddRequest	setDescription(String description)
BWSystem.SystemNetworkRoutingServerAddRequest	setNetAddress(String netAddress)
BWSystem.SystemNetworkRoutingServerAddRequest	setPoll(Boolean poll)
BWSystem.SystemNetworkRoutingServerAddRequest	setPort(Integer port)
BWSystem.SystemNetworkRoutingServerAddRequest	setTransportProtocol(TransportProtocol 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 Detail

netAddress

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

port

protected Integer port

transportProtocol

@NotNull
protected @NotNull TransportProtocol transportProtocol

poll

@NotNull
protected @NotNull Boolean poll

description

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

Constructor Detail

SystemNetworkRoutingServerAddRequest

public SystemNetworkRoutingServerAddRequest()

SystemNetworkRoutingServerAddRequest

public SystemNetworkRoutingServerAddRequest(BroadWorksServer broadWorksServer,
                                            String netAddress,
                                            TransportProtocol transportProtocol,
                                            Boolean poll)

Method Detail

setNetAddress

public BWSystem.SystemNetworkRoutingServerAddRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public BWSystem.SystemNetworkRoutingServerAddRequest setPort(Integer port)

getPort

public Integer getPort()

setTransportProtocol

public BWSystem.SystemNetworkRoutingServerAddRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

setPoll

public BWSystem.SystemNetworkRoutingServerAddRequest setPoll(Boolean poll)

getPoll

public Boolean getPoll()

setDescription

public BWSystem.SystemNetworkRoutingServerAddRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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