Package co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileModifyRequest

Enclosing class:

User

public static class User.UserAnnouncementFileModifyRequest
extends Request<DefaultResponse>

This command is used to change the name of the file or upload a new announcement file for an existing announcement in the user repository. When modifying the file type the command will fail if the media type of the new file changes the announcement from audio to video (or vice versa). 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 @Valid LabeledMediaFileResource	announcementFile
protected @NotNull @Valid AnnouncementFileKey	announcementFileKey
protected @Size(min=1,max=80) String	newAnnouncementFileName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAnnouncementFileModifyRequest()
UserAnnouncementFileModifyRequest(BroadWorksUser user, AnnouncementFileKey announcementFileKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
LabeledMediaFileResource	getAnnouncementFile()
AnnouncementFileKey	getAnnouncementFileKey()
BroadWorksUser	getBroadWorksUser()
static User.UserAnnouncementFileModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
String	getNewAnnouncementFileName()
User.UserAnnouncementFileModifyRequest	setAnnouncementFile(LabeledMediaFileResource announcementFile)
User.UserAnnouncementFileModifyRequest	setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)
User.UserAnnouncementFileModifyRequest	setNewAnnouncementFileName(String newAnnouncementFileName)
User.UserAnnouncementFileModifyRequest	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

announcementFileKey

@NotNull
@Valid
protected @NotNull @Valid AnnouncementFileKey announcementFileKey

newAnnouncementFileName

@Size(min=1,
      max=80)
protected @Size(min=1,max=80) String newAnnouncementFileName

announcementFile

@Valid
protected @Valid LabeledMediaFileResource announcementFile

Constructor Details

UserAnnouncementFileModifyRequest

public UserAnnouncementFileModifyRequest()

UserAnnouncementFileModifyRequest

public UserAnnouncementFileModifyRequest(BroadWorksUser user,
 AnnouncementFileKey announcementFileKey)

Method Details

setUser

public User.UserAnnouncementFileModifyRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileKey

public User.UserAnnouncementFileModifyRequest setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey getAnnouncementFileKey()

setNewAnnouncementFileName

public User.UserAnnouncementFileModifyRequest setNewAnnouncementFileName(String newAnnouncementFileName)

getNewAnnouncementFileName

public String getNewAnnouncementFileName()

setAnnouncementFile

public User.UserAnnouncementFileModifyRequest setAnnouncementFile(LabeledMediaFileResource announcementFile)

getAnnouncementFile

public LabeledMediaFileResource getAnnouncementFile()

getEmptyObject

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