Package co.ecg.alpaca.toolkit.generated

Class BWCustom.UserAnnouncementFileLocationGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWCustom.UserAnnouncementFileLocationGetResponse>

co.ecg.alpaca.toolkit.generated.BWCustom.UserAnnouncementFileLocationGetRequest

Enclosing class:

BWCustom

public static class BWCustom.UserAnnouncementFileLocationGetRequest
extends Request<BWCustom.UserAnnouncementFileLocationGetResponse>

Request to get the announcement repository file information. The response is either UserAnnouncementFileLocationGetResponse 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 @NotNull @Valid AnnouncementFileKey	announcementFileKey
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AnnouncementFileKey	getAnnouncementFileKey()
BroadWorksUser	getBroadWorksUser()
static BWCustom.UserAnnouncementFileLocationGetRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
BWCustom.UserAnnouncementFileLocationGetRequest	setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)
BWCustom.UserAnnouncementFileLocationGetRequest	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

Constructor Details

UserAnnouncementFileLocationGetRequest

public UserAnnouncementFileLocationGetRequest()

UserAnnouncementFileLocationGetRequest

public UserAnnouncementFileLocationGetRequest(BroadWorksUser user,
 AnnouncementFileKey announcementFileKey)

Method Details

setUser

public BWCustom.UserAnnouncementFileLocationGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileKey

public BWCustom.UserAnnouncementFileLocationGetRequest setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey getAnnouncementFileKey()

getEmptyObject

public static BWCustom.UserAnnouncementFileLocationGetRequest 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<BWCustom.UserAnnouncementFileLocationGetResponse>