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

@ChoiceGroup("groupExternalId") @ChoiceGroup("group")
public static class Group.GroupAnnouncementFileGetListRequest
extends Request<Group.GroupAnnouncementFileGetListResponse>

Get the list of available announcement files for a Group. The following elements are only used in AS data mode and ignored in XS data mode: groupExternalId 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 @Valid Group	group
protected @Size(max=36) String	groupExternalId
protected @NotNull Boolean	includeAnnouncementTable
protected 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, Boolean includeAnnouncementTable)
GroupAnnouncementFileGetListRequest(BroadWorksServer broadWorksServer, Boolean includeAnnouncementTable)
GroupAnnouncementFileGetListRequest(BroadWorksServer broadWorksServer, String groupExternalId, 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()
String	getGroupExternalId()
Boolean	getIncludeAnnouncementTable()
Integer	getResponseSizeLimit()
SearchCriteriaAnnouncementFileName[]	getSearchCriteriaAnnouncementFileName()
Group.GroupAnnouncementFileGetListRequest	setAnnouncementFileType(AnnouncementFileType announcementFileType)
Group.GroupAnnouncementFileGetListRequest	setGroup(Group group)
Group.GroupAnnouncementFileGetListRequest	setGroupExternalId(String groupExternalId)
Group.GroupAnnouncementFileGetListRequest	setIncludeAnnouncementTable(Boolean includeAnnouncementTable)
Group.GroupAnnouncementFileGetListRequest	setResponseSizeLimit(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, 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

group

@Valid
protected transient @Valid Group group

groupExternalId

@Size(max=36)
protected @Size(max=36) String groupExternalId

announcementFileType

protected AnnouncementFileType announcementFileType

includeAnnouncementTable

@NotNull
protected @NotNull Boolean includeAnnouncementTable

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaAnnouncementFileName

@Valid
protected @Valid SearchCriteriaAnnouncementFileName[] searchCriteriaAnnouncementFileName

Constructor Details

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest()

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(BroadWorksServer broadWorksServer,
 Boolean includeAnnouncementTable)

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(Group group,
 Boolean includeAnnouncementTable)

GroupAnnouncementFileGetListRequest

public GroupAnnouncementFileGetListRequest(BroadWorksServer broadWorksServer,
 String groupExternalId,
 Boolean includeAnnouncementTable)

Method Details

setGroup

public Group.GroupAnnouncementFileGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setGroupExternalId

public Group.GroupAnnouncementFileGetListRequest setGroupExternalId(String groupExternalId)

getGroupExternalId

public String getGroupExternalId()

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

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>