Package co.ecg.alpaca.toolkit.generated

Class Group.GroupAnnouncementFileModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupAnnouncementFileModifyRequest

Enclosing class:

Group

@ChoiceGroup({"group","announcementFileKey"}) @ChoiceGroup("announcementFileExternalId")
public static class Group.GroupAnnouncementFileModifyRequest
extends Request<DefaultResponse>

Modify an existing announcement in the group 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 @Valid LabeledMediaFileResource	announcementFile
protected @Size(max=36) String	announcementFileExternalId
protected @Valid AnnouncementFileKey	announcementFileKey
protected @Valid Group	group
protected @Size(min=1,max=80) String	newAnnouncementFileName

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAnnouncementFileModifyRequest()
GroupAnnouncementFileModifyRequest(Group group, AnnouncementFileKey announcementFileKey)
GroupAnnouncementFileModifyRequest(BroadWorksServer broadWorksServer)
GroupAnnouncementFileModifyRequest(BroadWorksServer broadWorksServer, String announcementFileExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
LabeledMediaFileResource	getAnnouncementFile()
String	getAnnouncementFileExternalId()
AnnouncementFileKey	getAnnouncementFileKey()
Group	getGroup()
String	getNewAnnouncementFileName()
Group.GroupAnnouncementFileModifyRequest	setAnnouncementFile(LabeledMediaFileResource announcementFile)
Group.GroupAnnouncementFileModifyRequest	setAnnouncementFileExternalId(String announcementFileExternalId)
Group.GroupAnnouncementFileModifyRequest	setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)
Group.GroupAnnouncementFileModifyRequest	setGroup(Group group)
Group.GroupAnnouncementFileModifyRequest	setNewAnnouncementFileName(String newAnnouncementFileName)

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

group

@Valid
protected transient @Valid Group group

announcementFileKey

@Valid
protected @Valid AnnouncementFileKey announcementFileKey

announcementFileExternalId

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

newAnnouncementFileName

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

announcementFile

@Valid
protected @Valid LabeledMediaFileResource announcementFile

Constructor Details

GroupAnnouncementFileModifyRequest

public GroupAnnouncementFileModifyRequest()

GroupAnnouncementFileModifyRequest

public GroupAnnouncementFileModifyRequest(BroadWorksServer broadWorksServer)

GroupAnnouncementFileModifyRequest

public GroupAnnouncementFileModifyRequest(Group group,
 AnnouncementFileKey announcementFileKey)

GroupAnnouncementFileModifyRequest

public GroupAnnouncementFileModifyRequest(BroadWorksServer broadWorksServer,
 String announcementFileExternalId)

Method Details

setGroup

public Group.GroupAnnouncementFileModifyRequest setGroup(Group group)

getGroup

public Group getGroup()

setAnnouncementFileKey

public Group.GroupAnnouncementFileModifyRequest setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey getAnnouncementFileKey()

setAnnouncementFileExternalId

public Group.GroupAnnouncementFileModifyRequest setAnnouncementFileExternalId(String announcementFileExternalId)

getAnnouncementFileExternalId

public String getAnnouncementFileExternalId()

setNewAnnouncementFileName

public Group.GroupAnnouncementFileModifyRequest setNewAnnouncementFileName(String newAnnouncementFileName)

getNewAnnouncementFileName

public String getNewAnnouncementFileName()

setAnnouncementFile

public Group.GroupAnnouncementFileModifyRequest setAnnouncementFile(LabeledMediaFileResource announcementFile)

getAnnouncementFile

public LabeledMediaFileResource getAnnouncementFile()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<DefaultResponse>