Package 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

Enclosing class:

User

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

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.

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 Boolean	includeAnnouncementTable
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaAnnouncementFileName[]	searchCriteriaAnnouncementFileName
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserAnnouncementFileGetListRequest()
UserAnnouncementFileGetListRequest(BroadWorksUser user, Boolean includeAnnouncementTable)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AnnouncementFileType	getAnnouncementFileType()
BroadWorksUser	getBroadWorksUser()
static User.UserAnnouncementFileGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getIncludeAnnouncementTable()
Integer	getResponseSizeLimit()
SearchCriteriaAnnouncementFileName[]	getSearchCriteriaAnnouncementFileName()
User.UserAnnouncementFileGetListRequest	setAnnouncementFileType(AnnouncementFileType announcementFileType)
User.UserAnnouncementFileGetListRequest	setIncludeAnnouncementTable(Boolean includeAnnouncementTable)
User.UserAnnouncementFileGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserAnnouncementFileGetListRequest	setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)
User.UserAnnouncementFileGetListRequest	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

includeAnnouncementTable

@NotNull
protected @NotNull Boolean includeAnnouncementTable

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaAnnouncementFileName

@Valid
protected @Valid SearchCriteriaAnnouncementFileName[] searchCriteriaAnnouncementFileName

Constructor Details

UserAnnouncementFileGetListRequest

public UserAnnouncementFileGetListRequest()

UserAnnouncementFileGetListRequest

public UserAnnouncementFileGetListRequest(BroadWorksUser user,
 Boolean includeAnnouncementTable)

Method Details

setUser

public User.UserAnnouncementFileGetListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

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>