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

Class SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest

java.lang.Object

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

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

Enclosing class:

SMDIMessageDesk

public static class SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest
extends Request<DefaultResponse>

Request to add a SMDI Server route 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 @NotNull @Size(min=1) String[]	deviceName
protected @NotNull @Size(min=1,max=10) String	routeDestination

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSMDIMessageDeskAddServerRouteRequest()
SystemSMDIMessageDeskAddServerRouteRequest(BroadWorksServer broadWorksServer, String routeDestination, String... deviceName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String[]	getDeviceName()
static SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getRouteDestination()
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest	setDeviceName(String... deviceName)
SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest	setRouteDestination(String routeDestination)

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

routeDestination

@NotNull
@Size(min=1,
      max=10)
protected @NotNull @Size(min=1,max=10) String routeDestination

deviceName

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

Constructor Details

SystemSMDIMessageDeskAddServerRouteRequest

public SystemSMDIMessageDeskAddServerRouteRequest()

SystemSMDIMessageDeskAddServerRouteRequest

public SystemSMDIMessageDeskAddServerRouteRequest(BroadWorksServer broadWorksServer,
 String routeDestination,
 String... deviceName)

Method Details

setRouteDestination

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest setRouteDestination(String routeDestination)

getRouteDestination

public String getRouteDestination()

setDeviceName

public SMDIMessageDesk.SystemSMDIMessageDeskAddServerRouteRequest setDeviceName(String... deviceName)

getDeviceName

public String[] getDeviceName()

getEmptyObject

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