Package co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserAnnouncementFileGetResponse>

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileGetRequest

Enclosing class:

User

@ChoiceGroup("announcementFileExternalId") @ChoiceGroup({"user","announcementFileKey"})
public static class User.UserAnnouncementFileGetRequest
extends Request<User.UserAnnouncementFileGetResponse>

Request to get the announcement repository file information. The following elements are only used in AS data mode and ignored in XS data mode: announcementFileExternalId The response is either UserAnnouncementFileGetResponse22 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 @Size(max=36) String	announcementFileExternalId
protected @Valid AnnouncementFileKey	announcementFileKey
protected @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAnnouncementFileGetRequest()
UserAnnouncementFileGetRequest(BroadWorksServer broadWorksServer)
UserAnnouncementFileGetRequest(BroadWorksServer broadWorksServer, String announcementFileExternalId)
UserAnnouncementFileGetRequest(BroadWorksUser user, AnnouncementFileKey announcementFileKey)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAnnouncementFileExternalId()
AnnouncementFileKey	getAnnouncementFileKey()
BroadWorksUser	getBroadWorksUser()
User.UserAnnouncementFileGetRequest	setAnnouncementFileExternalId(String announcementFileExternalId)
User.UserAnnouncementFileGetRequest	setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)
User.UserAnnouncementFileGetRequest	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

@Valid
protected transient @Valid BroadWorksUser user

announcementFileKey

@Valid
protected @Valid AnnouncementFileKey announcementFileKey

announcementFileExternalId

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

Constructor Details

UserAnnouncementFileGetRequest

public UserAnnouncementFileGetRequest()

UserAnnouncementFileGetRequest

public UserAnnouncementFileGetRequest(BroadWorksServer broadWorksServer)

UserAnnouncementFileGetRequest

public UserAnnouncementFileGetRequest(BroadWorksUser user,
 AnnouncementFileKey announcementFileKey)

UserAnnouncementFileGetRequest

public UserAnnouncementFileGetRequest(BroadWorksServer broadWorksServer,
 String announcementFileExternalId)

Method Details

setUser

public User.UserAnnouncementFileGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileKey

public User.UserAnnouncementFileGetRequest setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey getAnnouncementFileKey()

setAnnouncementFileExternalId

public User.UserAnnouncementFileGetRequest setAnnouncementFileExternalId(String announcementFileExternalId)

getAnnouncementFileExternalId

public String getAnnouncementFileExternalId()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<User.UserAnnouncementFileGetResponse>