co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileAddRequest

Enclosing class:

User

@GwtIncompatible
public static class User.UserAnnouncementFileAddRequest
extends Request<DefaultResponse>

Add an announcement to the user announcement repository 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 and Description
protected LabeledMediaFileResource	announcementFile
protected String	announcementFileName
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserAnnouncementFileAddRequest(BroadWorksUser user, String announcementFileName, LabeledMediaFileResource announcementFile)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
LabeledMediaFileResource	getAnnouncementFile()
String	getAnnouncementFileName()
BroadWorksUser	getBroadWorksUser()
static User.UserAnnouncementFileAddRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
User.UserAnnouncementFileAddRequest	setAnnouncementFile(LabeledMediaFileResource announcementFile)
User.UserAnnouncementFileAddRequest	setAnnouncementFileName(String announcementFileName)
User.UserAnnouncementFileAddRequest	setUser(BroadWorksUser user)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, 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 BroadWorksUser user

announcementFileName

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

announcementFile

@NotNull
protected LabeledMediaFileResource announcementFile

Constructor Detail

UserAnnouncementFileAddRequest

public UserAnnouncementFileAddRequest(BroadWorksUser user,
                                      String announcementFileName,
                                      LabeledMediaFileResource announcementFile)

Method Detail

setUser

public User.UserAnnouncementFileAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileName

public User.UserAnnouncementFileAddRequest setAnnouncementFileName(String announcementFileName)

getAnnouncementFileName

public String getAnnouncementFileName()

setAnnouncementFile

public User.UserAnnouncementFileAddRequest setAnnouncementFile(LabeledMediaFileResource announcementFile)

getAnnouncementFile

public LabeledMediaFileResource getAnnouncementFile()

getEmptyObject

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