Package 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

Enclosing class:

User

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

Request to get a user modifiable file. The response is either UserAccessDeviceFileGetResponse 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 @Valid AccessDevice	accessDevice
protected @NotNull @Size(min=1,max=128) String	fileFormat
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAccessDeviceFileGetRequest()
UserAccessDeviceFileGetRequest(BroadWorksUser user, AccessDevice accessDevice, String fileFormat)

Method Summary

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

Constructor Details

UserAccessDeviceFileGetRequest

public UserAccessDeviceFileGetRequest()

UserAccessDeviceFileGetRequest

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

Method Details

setUser

public User.UserAccessDeviceFileGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

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>