Package co.ecg.alpaca.toolkit.generated.services

Class SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest

Enclosing class:

SMDIMessageDesk

public static class SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest
extends Request<DefaultResponse>

Request to modify a SMDI 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=40) String	deviceName
protected @Size(min=1,max=80) String	netAddress
protected Integer	port

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSMDIMessageDeskModifyServerRequest()
SystemSMDIMessageDeskModifyServerRequest(BroadWorksServer broadWorksServer, String deviceName)

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()
String	getDeviceName()
static SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Integer	getPort()
SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	setDescription(String description)
SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	setDeviceName(String deviceName)
SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	setNetAddress(String netAddress)
SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	setPort(Integer port)
SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest	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

deviceName

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String deviceName

netAddress

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

port

protected Integer port

description

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

Constructor Details

SystemSMDIMessageDeskModifyServerRequest

public SystemSMDIMessageDeskModifyServerRequest()

SystemSMDIMessageDeskModifyServerRequest

public SystemSMDIMessageDeskModifyServerRequest(BroadWorksServer broadWorksServer,
 String deviceName)

Method Details

setDeviceName

public SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setNetAddress

public SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest setPort(Integer port)

getPort

public Integer getPort()

unsetDescription

public SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest unsetDescription()

setDescription

public SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest setDescription(String description)

getDescription

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

getEmptyObject

public static SMDIMessageDesk.SystemSMDIMessageDeskModifyServerRequest 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>