co.ecg.alpaca.toolkit.generated

Class User.UserAccessDeviceFileModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.Request<Response.DefaultResponse>

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

All Implemented Interfaces:

Runnable

Enclosing class:

User

public static class User.UserAccessDeviceFileModifyRequest
extends Request<Response.DefaultResponse>

Request to modify a user modifiable access device file. The response is either a SuccessResponse or an ErrorResponse.

Field Summary

Fields

Modifier and Type	Field and Description
AccessDevice	accessDevice
boolean	accessDeviceIsModified
String	fileFormat
boolean	fileFormatIsModified
FileResource	uploadFile
boolean	uploadFileIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserAccessDeviceFileModifyRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserAccessDeviceFileModifyRequest(User user, AccessDevice accessDevice, String fileFormat, FileResource uploadFile)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AccessDevice	getAccessDevice()
String	getFileFormat()
FileResource	getUploadFile()
User	getUser()
User.UserAccessDeviceFileModifyRequest	setAccessDevice(AccessDevice accessDevice)
User.UserAccessDeviceFileModifyRequest	setFileFormat(String fileFormat)
User.UserAccessDeviceFileModifyRequest	setUploadFile(FileResource uploadFile)
User.UserAccessDeviceFileModifyRequest	setUser(User user)

Methods inherited from class co.ecg.alpaca.toolkit.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

accessDevice

@NotNull
public AccessDevice accessDevice

accessDeviceIsModified

public transient boolean accessDeviceIsModified

fileFormat

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

fileFormatIsModified

public transient boolean fileFormatIsModified

uploadFile

@NotNull
public FileResource uploadFile

uploadFileIsModified

public transient boolean uploadFileIsModified

Constructor Detail

UserAccessDeviceFileModifyRequest

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

UserAccessDeviceFileModifyRequest

public UserAccessDeviceFileModifyRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public User.UserAccessDeviceFileModifyRequest setUser(User user)

getUser

public User getUser()

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()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Response.DefaultResponse>

Throws:

RequestException