Package co.ecg.alpaca.toolkit.generated

Class User.UserAccessDeviceFileModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAccessDeviceFileModifyRequest

Enclosing class:

User

public static class User.UserAccessDeviceFileModifyRequest
extends Request<DefaultResponse>

Request to modify a user modifiable 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 @NotNull @Valid AccessDevice	accessDevice
protected @NotNull @Size(min=1,max=128) String	fileFormat
protected @NotNull @Valid FileResource	uploadFile
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAccessDeviceFileModifyRequest()
UserAccessDeviceFileModifyRequest(BroadWorksUser user, AccessDevice accessDevice, String fileFormat, FileResource uploadFile)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AccessDevice	getAccessDevice()
BroadWorksUser	getBroadWorksUser()
static User.UserAccessDeviceFileModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getFileFormat()
FileResource	getUploadFile()
User.UserAccessDeviceFileModifyRequest	setAccessDevice(AccessDevice accessDevice)
User.UserAccessDeviceFileModifyRequest	setFileFormat(String fileFormat)
User.UserAccessDeviceFileModifyRequest	setUploadFile(FileResource uploadFile)
User.UserAccessDeviceFileModifyRequest	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 Details

user

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

accessDevice

@NotNull
@Valid
protected @NotNull @Valid AccessDevice accessDevice

fileFormat

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

uploadFile

@NotNull
@Valid
protected @NotNull @Valid FileResource uploadFile

Constructor Details

UserAccessDeviceFileModifyRequest

public UserAccessDeviceFileModifyRequest()

UserAccessDeviceFileModifyRequest

public UserAccessDeviceFileModifyRequest(BroadWorksUser user,
 AccessDevice accessDevice,
 String fileFormat,
 FileResource uploadFile)

Method Details

setUser

public User.UserAccessDeviceFileModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAccessDevice

public User.UserAccessDeviceFileModifyRequest setAccessDevice(AccessDevice accessDevice)

getAccessDevice

public AccessDevice getAccessDevice()

setFileFormat

public User.UserAccessDeviceFileModifyRequest setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

setUploadFile

public User.UserAccessDeviceFileModifyRequest setUploadFile(FileResource uploadFile)

getUploadFile

public FileResource getUploadFile()

getEmptyObject

public static User.UserAccessDeviceFileModifyRequest 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>