co.ecg.alpaca.toolkit.generated

Class User.UserAnnouncementFileGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserAnnouncementFileGetListRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

@GwtIncompatible
public static class User.UserAnnouncementFileGetListRequest
extends Request<User.UserAnnouncementFileGetListResponse>

AlpacaLibrary Auto-Generated Java File Get the list of announcement names with associated media type and filesize for a User and given Announcement Repository Type The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.

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 AnnouncementFileType	announcementFileType
protected Boolean	includeAnnouncementTable
protected Integer	responseSizeLimit
protected SearchCriteriaAnnouncementFileName[]	searchCriteriaAnnouncementFileName
protected User	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserAnnouncementFileGetListRequest(User user, Boolean includeAnnouncementTable)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AnnouncementFileType	getAnnouncementFileType()
static User.UserAnnouncementFileGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
Boolean	getIncludeAnnouncementTable()
Integer	getResponseSizeLimit()
SearchCriteriaAnnouncementFileName[]	getSearchCriteriaAnnouncementFileName()
User	getUser()
User.UserAnnouncementFileGetListRequest	setAnnouncementFileType(AnnouncementFileType announcementFileType)
User.UserAnnouncementFileGetListRequest	setIncludeAnnouncementTable(Boolean includeAnnouncementTable)
User.UserAnnouncementFileGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserAnnouncementFileGetListRequest	setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)
User.UserAnnouncementFileGetListRequest	setUser(User user)

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

appendChild, appendChild, appendChild, asyncFire, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, 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 User user

announcementFileType

protected AnnouncementFileType announcementFileType

includeAnnouncementTable

@NotNull
protected Boolean includeAnnouncementTable

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaAnnouncementFileName

protected SearchCriteriaAnnouncementFileName[] searchCriteriaAnnouncementFileName

Constructor Detail

UserAnnouncementFileGetListRequest

public UserAnnouncementFileGetListRequest(User user,
                                          Boolean includeAnnouncementTable)

Method Detail

setUser

public User.UserAnnouncementFileGetListRequest setUser(User user)

getUser

public User getUser()

setAnnouncementFileType

public User.UserAnnouncementFileGetListRequest setAnnouncementFileType(AnnouncementFileType announcementFileType)

getAnnouncementFileType

public AnnouncementFileType getAnnouncementFileType()

setIncludeAnnouncementTable

public User.UserAnnouncementFileGetListRequest setIncludeAnnouncementTable(Boolean includeAnnouncementTable)

getIncludeAnnouncementTable

public Boolean getIncludeAnnouncementTable()

setResponseSizeLimit

public User.UserAnnouncementFileGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaAnnouncementFileName

public User.UserAnnouncementFileGetListRequest setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)

getSearchCriteriaAnnouncementFileName

public SearchCriteriaAnnouncementFileName[] getSearchCriteriaAnnouncementFileName()

getEmptyObject

public static User.UserAnnouncementFileGetListRequest 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.UserAnnouncementFileGetListResponse>