Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceFileGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<SystemAccessDevice.SystemAccessDeviceFileGetResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceFileGetRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceFileGetRequest
extends Request<SystemAccessDevice.SystemAccessDeviceFileGetResponse>

Request to get a device profile file. The response is either SystemAccessDeviceFileGetResponse20 or 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=128) String	fileFormat
protected @NotNull @Valid SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceFileGetRequest()
SystemAccessDeviceFileGetRequest(SystemAccessDevice systemAccessDevice, String fileFormat)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceFileGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFileFormat()
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceFileGetRequest	setFileFormat(String fileFormat)
SystemAccessDevice.SystemAccessDeviceFileGetRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

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

systemAccessDevice

@NotNull
@Valid
protected transient @NotNull @Valid SystemAccessDevice systemAccessDevice

fileFormat

@NotNull
@Size(min=1,
      max=128)
protected @NotNull @Size(min=1,max=128) String fileFormat

Constructor Details

SystemAccessDeviceFileGetRequest

public SystemAccessDeviceFileGetRequest()

SystemAccessDeviceFileGetRequest

public SystemAccessDeviceFileGetRequest(SystemAccessDevice systemAccessDevice,
 String fileFormat)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceFileGetRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setFileFormat

public SystemAccessDevice.SystemAccessDeviceFileGetRequest setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

getEmptyObject

public static SystemAccessDevice.SystemAccessDeviceFileGetRequest 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<SystemAccessDevice.SystemAccessDeviceFileGetResponse>