Package co.ecg.alpaca.toolkit.generated

Class Group.GroupGetListInSystemRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupGetListInSystemRequest

Enclosing class:

Group

public static class Group.GroupGetListInSystemRequest
extends Request<Group.GroupGetListInSystemResponse>

Request the list of groups in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the groups in the administrator's reseller meeting the search criteria are returned. The response is either a GroupGetListInSystemResponse or an ErrorResponse. The following data elements are only used in AS data mode: searchCriteriaResellerId

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 Integer	responseSizeLimit
protected @Valid SearchCriteriaExactServiceProvider	searchCriteriaExactServiceProvider
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaGroupName[]	searchCriteriaGroupName
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId

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

log

Constructor Summary

Constructors

Constructor	Description
GroupGetListInSystemRequest()
GroupGetListInSystemRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaExactServiceProvider	getSearchCriteriaExactServiceProvider()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaGroupName[]	getSearchCriteriaGroupName()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
Group.GroupGetListInSystemRequest	setResponseSizeLimit(Integer responseSizeLimit)
Group.GroupGetListInSystemRequest	setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)
Group.GroupGetListInSystemRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
Group.GroupGetListInSystemRequest	setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)
Group.GroupGetListInSystemRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)
Group.GroupGetListInSystemRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaGroupName

@Valid
protected @Valid SearchCriteriaGroupName[] searchCriteriaGroupName

searchCriteriaExactServiceProvider

@Valid
protected @Valid SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider

searchCriteriaServiceProviderId

@Valid
protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaResellerId

@Valid
protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

Constructor Details

GroupGetListInSystemRequest

public GroupGetListInSystemRequest()

GroupGetListInSystemRequest

public GroupGetListInSystemRequest(BroadWorksServer broadWorksServer)

Method Details

setResponseSizeLimit

public Group.GroupGetListInSystemRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaGroupId

public Group.GroupGetListInSystemRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaGroupName

public Group.GroupGetListInSystemRequest setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)

getSearchCriteriaGroupName

public SearchCriteriaGroupName[] getSearchCriteriaGroupName()

setSearchCriteriaExactServiceProvider

public Group.GroupGetListInSystemRequest setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)

getSearchCriteriaExactServiceProvider

public SearchCriteriaExactServiceProvider getSearchCriteriaExactServiceProvider()

setSearchCriteriaServiceProviderId

public Group.GroupGetListInSystemRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaResellerId

public Group.GroupGetListInSystemRequest setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)

getSearchCriteriaResellerId

public SearchCriteriaResellerId[] getSearchCriteriaResellerId()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<Group.GroupGetListInSystemResponse>