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

Class SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest

java.lang.Object

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

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

Enclosing class:

SMDIMessageDesk

public static class SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest
extends Request<DefaultResponse>

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

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSMDIMessageDeskAddServerRequest()
SystemSMDIMessageDeskAddServerRequest(BroadWorksServer broadWorksServer, String deviceName, String netAddress, Integer port)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDescription()
String	getDeviceName()
static SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Integer	getPort()
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest	setDescription(String description)
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest	setDeviceName(String deviceName)
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest	setNetAddress(String netAddress)
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest	setPort(Integer port)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

deviceName

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

netAddress

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

port

@NotNull
protected @NotNull Integer port

description

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

Constructor Detail

SystemSMDIMessageDeskAddServerRequest

public SystemSMDIMessageDeskAddServerRequest()

SystemSMDIMessageDeskAddServerRequest

public SystemSMDIMessageDeskAddServerRequest(BroadWorksServer broadWorksServer,
                                             String deviceName,
                                             String netAddress,
                                             Integer port)

Method Detail

setDeviceName

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setNetAddress

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest setPort(Integer port)

getPort

public Integer getPort()

setDescription

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRequest setDescription(String description)

getDescription

public String getDescription()

getEmptyObject

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