Package co.ecg.alpaca.toolkit.generated

Class Group.GroupCommonPhoneListGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupCommonPhoneListGetListRequest

Enclosing class:

Group

public static class Group.GroupCommonPhoneListGetListRequest
extends Request<Group.GroupCommonPhoneListGetListResponse>

Get a group's common phone list. The response is either a GroupCommonPhoneListGetListResponse or an ErrorResponse. The search can be done using multiple criterion. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterion are included in the results. If no search criteria is specified, all results are returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned.

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 @NotNull @Valid Group	group
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaGroupCommonPhoneListName[]	searchCriteriaGroupCommonPhoneListName
protected @Valid SearchCriteriaGroupCommonPhoneListNumber[]	searchCriteriaGroupCommonPhoneListNumber
protected @AssertTrue Boolean	searchCriteriaModeOr

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCommonPhoneListGetListRequest()
GroupCommonPhoneListGetListRequest(Group group)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Group.GroupCommonPhoneListGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Integer	getResponseSizeLimit()
SearchCriteriaGroupCommonPhoneListName[]	getSearchCriteriaGroupCommonPhoneListName()
SearchCriteriaGroupCommonPhoneListNumber[]	getSearchCriteriaGroupCommonPhoneListNumber()
Boolean	getSearchCriteriaModeOr()
boolean	searchCriteriaModeOrFlagExist()
Group.GroupCommonPhoneListGetListRequest	setFlagSearchCriteriaModeOr()
Group.GroupCommonPhoneListGetListRequest	setGroup(Group group)
Group.GroupCommonPhoneListGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
Group.GroupCommonPhoneListGetListRequest	setSearchCriteriaGroupCommonPhoneListName(SearchCriteriaGroupCommonPhoneListName... searchCriteriaGroupCommonPhoneListName)
Group.GroupCommonPhoneListGetListRequest	setSearchCriteriaGroupCommonPhoneListNumber(SearchCriteriaGroupCommonPhoneListNumber... searchCriteriaGroupCommonPhoneListNumber)

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

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

searchCriteriaGroupCommonPhoneListName

@Valid
protected @Valid SearchCriteriaGroupCommonPhoneListName[] searchCriteriaGroupCommonPhoneListName

searchCriteriaGroupCommonPhoneListNumber

@Valid
protected @Valid SearchCriteriaGroupCommonPhoneListNumber[] searchCriteriaGroupCommonPhoneListNumber

Constructor Details

GroupCommonPhoneListGetListRequest

public GroupCommonPhoneListGetListRequest()

GroupCommonPhoneListGetListRequest

public GroupCommonPhoneListGetListRequest(Group group)

Method Details

setGroup

public Group.GroupCommonPhoneListGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setResponseSizeLimit

public Group.GroupCommonPhoneListGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public Group.GroupCommonPhoneListGetListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaGroupCommonPhoneListName

public Group.GroupCommonPhoneListGetListRequest setSearchCriteriaGroupCommonPhoneListName(SearchCriteriaGroupCommonPhoneListName... searchCriteriaGroupCommonPhoneListName)

getSearchCriteriaGroupCommonPhoneListName

public SearchCriteriaGroupCommonPhoneListName[] getSearchCriteriaGroupCommonPhoneListName()

setSearchCriteriaGroupCommonPhoneListNumber

public Group.GroupCommonPhoneListGetListRequest setSearchCriteriaGroupCommonPhoneListNumber(SearchCriteriaGroupCommonPhoneListNumber... searchCriteriaGroupCommonPhoneListNumber)

getSearchCriteriaGroupCommonPhoneListNumber

public SearchCriteriaGroupCommonPhoneListNumber[] getSearchCriteriaGroupCommonPhoneListNumber()

getEmptyObject

public static Group.GroupCommonPhoneListGetListRequest 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.GroupCommonPhoneListGetListResponse>