co.ecg.alpaca.toolkit.generated

Class Group.GroupAnnouncementFileGetListRequest

java.lang.Object

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

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

All Implemented Interfaces:

Runnable

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.

Field Summary

Fields

Modifier and Type	Field and Description
AnnouncementFileType	announcementFileType
boolean	announcementFileTypeIsModified
Group	group
boolean	groupIsModified
Boolean	includeAnnouncementTable
boolean	includeAnnouncementTableIsModified
Integer	responseSizeLimit
boolean	responseSizeLimitIsModified
SearchCriteriaAnnouncementFileName[]	searchCriteriaAnnouncementFileName
boolean	searchCriteriaAnnouncementFileNameIsModified

Constructor Summary

Constructors

Constructor and Description
GroupAnnouncementFileGetListRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
GroupAnnouncementFileGetListRequest(Group group, Boolean includeAnnouncementTable)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
AnnouncementFileType	getAnnouncementFileType()
Group	getGroup()
Boolean	getIncludeAnnouncementTable()
Integer	getResponseSizeLimit()
SearchCriteriaAnnouncementFileName[]	getSearchCriteriaAnnouncementFileName()
Group.GroupAnnouncementFileGetListRequest	setAnnouncementFileType(AnnouncementFileType announcementFileType)
Group.GroupAnnouncementFileGetListRequest	setGroup(Group group)
Group.GroupAnnouncementFileGetListRequest	setIncludeAnnouncementTable(Boolean includeAnnouncementTable)
Group.GroupAnnouncementFileGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
Group.GroupAnnouncementFileGetListRequest	setSearchCriteriaAnnouncementFileName(SearchCriteriaAnnouncementFileName... searchCriteriaAnnouncementFileName)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandType, getDomDocument, getResponseClass, 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

group

@NotNull
public Group group

groupIsModified

public transient boolean groupIsModified

announcementFileType

public AnnouncementFileType announcementFileType

announcementFileTypeIsModified

public transient boolean announcementFileTypeIsModified

includeAnnouncementTable

public Boolean includeAnnouncementTable

includeAnnouncementTableIsModified

public transient boolean includeAnnouncementTableIsModified

responseSizeLimit

public Integer responseSizeLimit

responseSizeLimitIsModified

public transient boolean responseSizeLimitIsModified

searchCriteriaAnnouncementFileName

public SearchCriteriaAnnouncementFileName[] searchCriteriaAnnouncementFileName

searchCriteriaAnnouncementFileNameIsModified

public transient boolean searchCriteriaAnnouncementFileNameIsModified

Constructor Detail

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(Group group,
                                           Boolean includeAnnouncementTable)

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

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(Boolean includeAnnouncementTable)

getIncludeAnnouncementTable

public Boolean getIncludeAnnouncementTable()

setResponseSizeLimit

public Group.GroupAnnouncementFileGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaAnnouncementFileName

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

getSearchCriteriaAnnouncementFileName

public SearchCriteriaAnnouncementFileName[] getSearchCriteriaAnnouncementFileName()

formRequest

public void formRequest()
                 throws RequestException

Forms the XML Document for this Request Object. Called by the Request upon fire().

Specified by:

formRequest in class Request<Group.GroupAnnouncementFileGetListResponse>

Throws:

RequestException