Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemConfigurableTreatmentGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemConfigurableTreatmentGetResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemConfigurableTreatmentGetRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemConfigurableTreatmentGetRequest
extends Request<BWSystem.SystemConfigurableTreatmentGetResponse>

Get all the attributes of a configurable treatment. The response is either a SystemConfigurableTreatmentGetResponse16 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	treatmentId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemConfigurableTreatmentGetRequest()
SystemConfigurableTreatmentGetRequest(BroadWorksServer broadWorksServer, String treatmentId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static BWSystem.SystemConfigurableTreatmentGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getTreatmentId()
BWSystem.SystemConfigurableTreatmentGetRequest	setTreatmentId(String treatmentId)

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

treatmentId

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

Constructor Detail

SystemConfigurableTreatmentGetRequest

public SystemConfigurableTreatmentGetRequest()

SystemConfigurableTreatmentGetRequest

public SystemConfigurableTreatmentGetRequest(BroadWorksServer broadWorksServer,
                                             String treatmentId)

Method Detail

setTreatmentId

public BWSystem.SystemConfigurableTreatmentGetRequest setTreatmentId(String treatmentId)

getTreatmentId

public String getTreatmentId()

getEmptyObject

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