Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceFileModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceFileModifyRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceFileModifyRequest
extends Request<DefaultResponse>

Request to modify a specified system access device file. 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 Boolean	extendedCaptureEnabled
protected @NotNull @Size(min=1,max=128) String	fileFormat
protected AccessDeviceEnhancedConfigurationMode	fileSource
protected @NotNull @Valid SystemAccessDevice	systemAccessDevice
protected @Valid FileResource	uploadFile

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static SystemAccessDevice.SystemAccessDeviceFileModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getExtendedCaptureEnabled()
String	getFileFormat()
AccessDeviceEnhancedConfigurationMode	getFileSource()
SystemAccessDevice	getSystemAccessDevice()
FileResource	getUploadFile()
SystemAccessDevice.SystemAccessDeviceFileModifyRequest	setExtendedCaptureEnabled(Boolean extendedCaptureEnabled)
SystemAccessDevice.SystemAccessDeviceFileModifyRequest	setFileFormat(String fileFormat)
SystemAccessDevice.SystemAccessDeviceFileModifyRequest	setFileSource(AccessDeviceEnhancedConfigurationMode fileSource)
SystemAccessDevice.SystemAccessDeviceFileModifyRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)
SystemAccessDevice.SystemAccessDeviceFileModifyRequest	setUploadFile(FileResource uploadFile)

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

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

fileSource

protected AccessDeviceEnhancedConfigurationMode fileSource

uploadFile

@Valid
protected @Valid FileResource uploadFile

extendedCaptureEnabled

protected Boolean extendedCaptureEnabled

Constructor Detail

SystemAccessDeviceFileModifyRequest

public SystemAccessDeviceFileModifyRequest()

SystemAccessDeviceFileModifyRequest

public SystemAccessDeviceFileModifyRequest(SystemAccessDevice systemAccessDevice,
                                           String fileFormat)

Method Detail

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceFileModifyRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setFileFormat

public SystemAccessDevice.SystemAccessDeviceFileModifyRequest setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

setFileSource

public SystemAccessDevice.SystemAccessDeviceFileModifyRequest setFileSource(AccessDeviceEnhancedConfigurationMode fileSource)

getFileSource

public AccessDeviceEnhancedConfigurationMode getFileSource()

setUploadFile

public SystemAccessDevice.SystemAccessDeviceFileModifyRequest setUploadFile(FileResource uploadFile)

getUploadFile

public FileResource getUploadFile()

setExtendedCaptureEnabled

public SystemAccessDevice.SystemAccessDeviceFileModifyRequest setExtendedCaptureEnabled(Boolean extendedCaptureEnabled)

getExtendedCaptureEnabled

public Boolean getExtendedCaptureEnabled()

getEmptyObject

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