Package co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileGetAvailableListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileGetAvailableListRequest

Enclosing class:

User

public static class User.UserAnnouncementFileGetAvailableListRequest
extends Request<User.UserAnnouncementFileGetAvailableListResponse>

Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.

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 AnnouncementFileType	announcementFileType
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAnnouncementFileGetAvailableListRequest()
UserAnnouncementFileGetAvailableListRequest(BroadWorksUser user)

Method Summary

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

announcementFileType

protected AnnouncementFileType announcementFileType

Constructor Details

UserAnnouncementFileGetAvailableListRequest

public UserAnnouncementFileGetAvailableListRequest()

UserAnnouncementFileGetAvailableListRequest

public UserAnnouncementFileGetAvailableListRequest(BroadWorksUser user)

Method Details

setUser

public User.UserAnnouncementFileGetAvailableListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setAnnouncementFileType

public User.UserAnnouncementFileGetAvailableListRequest setAnnouncementFileType(AnnouncementFileType announcementFileType)

getAnnouncementFileType

public AnnouncementFileType getAnnouncementFileType()

getEmptyObject

public static User.UserAnnouncementFileGetAvailableListRequest 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.UserAnnouncementFileGetAvailableListResponse>