Package 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

@ChoiceGroup("announcementFileName") @ChoiceGroup("announcementFileExternalId")
public static class User.UserAnnouncementFileAddRequest
extends Request<DefaultResponse>

Add an announcement to the user announcement repository The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId 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 @NotNull @Valid LabeledMediaFileResource	announcementFile
protected @Size(max=36) String	announcementFileExternalId
protected @Size(min=1,max=80) String	announcementFileName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
LabeledMediaFileResource	getAnnouncementFile()
String	getAnnouncementFileExternalId()
String	getAnnouncementFileName()
BroadWorksUser	getBroadWorksUser()
static User.UserAnnouncementFileAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
User.UserAnnouncementFileAddRequest	setAnnouncementFile(LabeledMediaFileResource announcementFile)
User.UserAnnouncementFileAddRequest	setAnnouncementFileExternalId(String announcementFileExternalId)
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, 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

announcementFileName

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

announcementFileExternalId

@Size(max=36)
protected @Size(max=36) String announcementFileExternalId

announcementFile

@NotNull
@Valid
protected @NotNull @Valid LabeledMediaFileResource announcementFile

Constructor Details

UserAnnouncementFileAddRequest

public UserAnnouncementFileAddRequest()

UserAnnouncementFileAddRequest

public UserAnnouncementFileAddRequest(BroadWorksUser user,
 LabeledMediaFileResource announcementFile)

UserAnnouncementFileAddRequest

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

Method Details

setUser

public User.UserAnnouncementFileAddRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileName

public User.UserAnnouncementFileAddRequest setAnnouncementFileName(String announcementFileName)

getAnnouncementFileName

public String getAnnouncementFileName()

setAnnouncementFileExternalId

public User.UserAnnouncementFileAddRequest setAnnouncementFileExternalId(String announcementFileExternalId)

getAnnouncementFileExternalId

public String getAnnouncementFileExternalId()

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>