Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemVideoServerAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemVideoServerAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemVideoServerAddRequest
extends Request<DefaultResponse>

Request to add a video 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 Integer	port
protected @NotNull TransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

Constructor	Description
SystemVideoServerAddRequest()
SystemVideoServerAddRequest(BroadWorksServer broadWorksServer, String netAddress, TransportProtocol transportProtocol)

Method Summary

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

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

description

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

Constructor Details

SystemVideoServerAddRequest

public SystemVideoServerAddRequest()

SystemVideoServerAddRequest

public SystemVideoServerAddRequest(BroadWorksServer broadWorksServer,
 String netAddress,
 TransportProtocol transportProtocol)

Method Details

setNetAddress

public BWSystem.SystemVideoServerAddRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public BWSystem.SystemVideoServerAddRequest setPort(Integer port)

getPort

public Integer getPort()

setTransportProtocol

public BWSystem.SystemVideoServerAddRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

setDescription

public BWSystem.SystemVideoServerAddRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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