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

@GwtIncompatible
public static class User.UserAnnouncementFileGetRequest
extends Request<User.UserAnnouncementFileGetResponse>

Request to get the announcement repository file information. The response is either UserAnnouncementFileGetResponse 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 and Description
protected AnnouncementFileKey	announcementFileKey
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserAnnouncementFileGetRequest(BroadWorksUser user, AnnouncementFileKey announcementFileKey)

Method Summary

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

announcementFileKey

@NotNull
protected AnnouncementFileKey announcementFileKey

Constructor Detail

UserAnnouncementFileGetRequest

public UserAnnouncementFileGetRequest(BroadWorksUser user,
                                      AnnouncementFileKey announcementFileKey)

Method Detail

setUser

public User.UserAnnouncementFileGetRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileKey

public User.UserAnnouncementFileGetRequest setAnnouncementFileKey(AnnouncementFileKey announcementFileKey)

getAnnouncementFileKey

public AnnouncementFileKey getAnnouncementFileKey()

getEmptyObject

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