Package co.ecg.alpaca.toolkit.generated

Class Group.GroupAnnouncementFileGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupAnnouncementFileGetListResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupAnnouncementFileGetListRequest

Enclosing class:

Group

public static class Group.GroupAnnouncementFileGetListRequest
extends Request<Group.GroupAnnouncementFileGetListResponse>

Get the list of available announcement files for a Group. The response is either a GroupAnnouncementFileGetListResponse 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 @Valid Group	group
protected @NotNull java.lang.Boolean	includeAnnouncementTable
protected java.lang.Integer	responseSizeLimit
protected @Valid SearchCriteriaAnnouncementFileName[]	searchCriteriaAnnouncementFileName

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

log

Constructor Summary

Constructors

Constructor	Description
GroupAnnouncementFileGetListRequest()
GroupAnnouncementFileGetListRequest(Group group, java.lang.Boolean includeAnnouncementTable)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
AnnouncementFileType	getAnnouncementFileType()
static Group.GroupAnnouncementFileGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
java.lang.Boolean	getIncludeAnnouncementTable()
java.lang.Integer	getResponseSizeLimit()
SearchCriteriaAnnouncementFileName[]	getSearchCriteriaAnnouncementFileName()
Group.GroupAnnouncementFileGetListRequest	setAnnouncementFileType(AnnouncementFileType announcementFileType)
Group.GroupAnnouncementFileGetListRequest	setGroup(Group group)
Group.GroupAnnouncementFileGetListRequest	setIncludeAnnouncementTable(java.lang.Boolean includeAnnouncementTable)
Group.GroupAnnouncementFileGetListRequest	setResponseSizeLimit(java.lang.Integer responseSizeLimit)
Group.GroupAnnouncementFileGetListRequest	setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

group

@NotNull @Valid protected transient @NotNull @Valid Group group

announcementFileType

protected AnnouncementFileType announcementFileType

includeAnnouncementTable

@NotNull protected @NotNull java.lang.Boolean includeAnnouncementTable

responseSizeLimit

protected java.lang.Integer responseSizeLimit

searchCriteriaAnnouncementFileName

@Valid protected @Valid SearchCriteriaAnnouncementFileName[] searchCriteriaAnnouncementFileName

Constructor Details

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest()

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(Group group, java.lang.Boolean includeAnnouncementTable)

Method Details

setGroup

public Group.GroupAnnouncementFileGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setAnnouncementFileType

public Group.GroupAnnouncementFileGetListRequest setAnnouncementFileType(AnnouncementFileType announcementFileType)

getAnnouncementFileType

public AnnouncementFileType getAnnouncementFileType()

setIncludeAnnouncementTable

public Group.GroupAnnouncementFileGetListRequest setIncludeAnnouncementTable(java.lang.Boolean includeAnnouncementTable)

getIncludeAnnouncementTable

public java.lang.Boolean getIncludeAnnouncementTable()

setResponseSizeLimit

public Group.GroupAnnouncementFileGetListRequest setResponseSizeLimit(java.lang.Integer responseSizeLimit)

getResponseSizeLimit

public java.lang.Integer getResponseSizeLimit()

setSearchCriteriaAnnouncementFileName

public Group.GroupAnnouncementFileGetListRequest setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)

getSearchCriteriaAnnouncementFileName

public SearchCriteriaAnnouncementFileName[] getSearchCriteriaAnnouncementFileName()

getEmptyObject

public static Group.GroupAnnouncementFileGetListRequest 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<Group.GroupAnnouncementFileGetListResponse>