co.ecg.alpaca.toolkit.generated

Class User.UserAccessDeviceFileGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserAccessDeviceFileGetResponse>

co.ecg.alpaca.toolkit.generated.User.UserAccessDeviceFileGetRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

@GwtIncompatible
public static class User.UserAccessDeviceFileGetRequest
extends Request<User.UserAccessDeviceFileGetResponse>

AlpacaLibrary Auto-Generated Java File Request to get a user modifiable file. The response is either UserAccessDeviceFileGetResponse or ErrorResponse.

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 and Description
protected AccessDevice	accessDevice
protected String	fileFormat
protected User	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserAccessDeviceFileGetRequest(User user, AccessDevice accessDevice, String fileFormat)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AccessDevice	getAccessDevice()
static User.UserAccessDeviceFileGetRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
String	getFileFormat()
User	getUser()
User.UserAccessDeviceFileGetRequest	setAccessDevice(AccessDevice accessDevice)
User.UserAccessDeviceFileGetRequest	setFileFormat(String fileFormat)
User.UserAccessDeviceFileGetRequest	setUser(User user)

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

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, 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
protected transient User user

accessDevice

@NotNull
protected AccessDevice accessDevice

fileFormat

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

Constructor Detail

UserAccessDeviceFileGetRequest

public UserAccessDeviceFileGetRequest(User user,
                                      AccessDevice accessDevice,
                                      String fileFormat)

Method Detail

setUser

public User.UserAccessDeviceFileGetRequest setUser(User user)

getUser

public User getUser()

setAccessDevice

public User.UserAccessDeviceFileGetRequest setAccessDevice(AccessDevice accessDevice)

getAccessDevice

public AccessDevice getAccessDevice()

setFileFormat

public User.UserAccessDeviceFileGetRequest setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

getEmptyObject

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