Package co.ecg.alpaca.toolkit.generated

Class Enterprise.EnterpriseCommonPhoneListGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Enterprise.EnterpriseCommonPhoneListGetListResponse>

co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseCommonPhoneListGetListRequest

Enclosing class:

Enterprise

public static class Enterprise.EnterpriseCommonPhoneListGetListRequest
extends Request<Enterprise.EnterpriseCommonPhoneListGetListResponse>

Get an enterprise's common phone list. The response is either a EnterpriseCommonPhoneListGetListResponse 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 Enterprise	enterprise
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaEnterpriseCommonPhoneListName[]	searchCriteriaEnterpriseCommonPhoneListName
protected @Valid SearchCriteriaEnterpriseCommonPhoneListNumber[]	searchCriteriaEnterpriseCommonPhoneListNumber
protected @AssertTrue Boolean	searchCriteriaModeOr

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

log

Constructor Summary

Constructors

Constructor	Description
EnterpriseCommonPhoneListGetListRequest()
EnterpriseCommonPhoneListGetListRequest(Enterprise enterprise)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Enterprise.EnterpriseCommonPhoneListGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Enterprise	getEnterprise()
Integer	getResponseSizeLimit()
SearchCriteriaEnterpriseCommonPhoneListName[]	getSearchCriteriaEnterpriseCommonPhoneListName()
SearchCriteriaEnterpriseCommonPhoneListNumber[]	getSearchCriteriaEnterpriseCommonPhoneListNumber()
Boolean	getSearchCriteriaModeOr()
boolean	searchCriteriaModeOrFlagExist()
Enterprise.EnterpriseCommonPhoneListGetListRequest	setEnterprise(Enterprise enterprise)
Enterprise.EnterpriseCommonPhoneListGetListRequest	setFlagSearchCriteriaModeOr()
Enterprise.EnterpriseCommonPhoneListGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
Enterprise.EnterpriseCommonPhoneListGetListRequest	setSearchCriteriaEnterpriseCommonPhoneListName(SearchCriteriaEnterpriseCommonPhoneListName... searchCriteriaEnterpriseCommonPhoneListName)
Enterprise.EnterpriseCommonPhoneListGetListRequest	setSearchCriteriaEnterpriseCommonPhoneListNumber(SearchCriteriaEnterpriseCommonPhoneListNumber... searchCriteriaEnterpriseCommonPhoneListNumber)

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

enterprise

@NotNull
@Valid
protected transient @NotNull @Valid Enterprise enterprise

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

searchCriteriaEnterpriseCommonPhoneListName

@Valid
protected @Valid SearchCriteriaEnterpriseCommonPhoneListName[] searchCriteriaEnterpriseCommonPhoneListName

searchCriteriaEnterpriseCommonPhoneListNumber

@Valid
protected @Valid SearchCriteriaEnterpriseCommonPhoneListNumber[] searchCriteriaEnterpriseCommonPhoneListNumber

Constructor Details

EnterpriseCommonPhoneListGetListRequest

public EnterpriseCommonPhoneListGetListRequest()

EnterpriseCommonPhoneListGetListRequest

public EnterpriseCommonPhoneListGetListRequest(Enterprise enterprise)

Method Details

setEnterprise

public Enterprise.EnterpriseCommonPhoneListGetListRequest setEnterprise(Enterprise enterprise)

getEnterprise

public Enterprise getEnterprise()

setResponseSizeLimit

public Enterprise.EnterpriseCommonPhoneListGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public Enterprise.EnterpriseCommonPhoneListGetListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaEnterpriseCommonPhoneListName

public Enterprise.EnterpriseCommonPhoneListGetListRequest setSearchCriteriaEnterpriseCommonPhoneListName(SearchCriteriaEnterpriseCommonPhoneListName... searchCriteriaEnterpriseCommonPhoneListName)

getSearchCriteriaEnterpriseCommonPhoneListName

public SearchCriteriaEnterpriseCommonPhoneListName[] getSearchCriteriaEnterpriseCommonPhoneListName()

setSearchCriteriaEnterpriseCommonPhoneListNumber

public Enterprise.EnterpriseCommonPhoneListGetListRequest setSearchCriteriaEnterpriseCommonPhoneListNumber(SearchCriteriaEnterpriseCommonPhoneListNumber... searchCriteriaEnterpriseCommonPhoneListNumber)

getSearchCriteriaEnterpriseCommonPhoneListNumber

public SearchCriteriaEnterpriseCommonPhoneListNumber[] getSearchCriteriaEnterpriseCommonPhoneListNumber()

getEmptyObject

public static Enterprise.EnterpriseCommonPhoneListGetListRequest 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<Enterprise.EnterpriseCommonPhoneListGetListResponse>