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

Class UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.services.UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest

Enclosing class:

UserSMDIMessageDesk

public static class UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest
extends Request<DefaultResponse>

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

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

log

Constructor Summary

Constructors

Constructor	Description
UserSMDIMessageDeskAddServerRequest()
UserSMDIMessageDeskAddServerRequest(BroadWorksServer broadWorksServer, BroadWorksUser user, String deviceName, String netAddress, Integer port)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
String	getDeviceName()
static UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNetAddress()
Integer	getPort()
UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest	setDeviceName(String deviceName)
UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest	setNetAddress(String netAddress)
UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest	setPort(Integer port)
UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest	setUser(BroadWorksUser user)

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

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

Constructor Detail

UserSMDIMessageDeskAddServerRequest

public UserSMDIMessageDeskAddServerRequest()

UserSMDIMessageDeskAddServerRequest

public UserSMDIMessageDeskAddServerRequest(BroadWorksServer broadWorksServer,
                                           BroadWorksUser user,
                                           String deviceName,
                                           String netAddress,
                                           Integer port)

Method Detail

setUser

public UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setDeviceName

public UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest setDeviceName(String deviceName)

getDeviceName

public String getDeviceName()

setNetAddress

public UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest setNetAddress(String netAddress)

getNetAddress

public String getNetAddress()

setPort

public UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest setPort(Integer port)

getPort

public Integer getPort()

getEmptyObject

public static UserSMDIMessageDesk.UserSMDIMessageDeskAddServerRequest 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>