Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemMediaServerModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemMediaServerModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemMediaServerModifyRequest
extends Request<DefaultResponse>

Request to modify a Media 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 Optional<Integer>	port
protected TransportProtocol	transportProtocol

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

log

Constructor Summary

Constructors

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

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

description

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

Constructor Detail

SystemMediaServerModifyRequest

public SystemMediaServerModifyRequest()

SystemMediaServerModifyRequest

public SystemMediaServerModifyRequest(BroadWorksServer broadWorksServer,
                                      String netAddress)

Method Detail

setNetAddress

public BWSystem.SystemMediaServerModifyRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

unsetPort

public BWSystem.SystemMediaServerModifyRequest unsetPort()

setPort

public BWSystem.SystemMediaServerModifyRequest setPort(Integer port)

getPort

public Optional<Integer> getPort()

setTransportProtocol

public BWSystem.SystemMediaServerModifyRequest setTransportProtocol(TransportProtocol transportProtocol)

getTransportProtocol

public TransportProtocol getTransportProtocol()

unsetDescription

public BWSystem.SystemMediaServerModifyRequest unsetDescription()

setDescription

public BWSystem.SystemMediaServerModifyRequest setDescription(String description)

getDescription

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

getEmptyObject

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