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

All Implemented Interfaces:

Runnable

Enclosing class:

Enterprise

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

AlpacaLibrary Auto-Generated Java File 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.

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 and Description
protected Integer	responseSizeLimit
protected SearchCriteriaEnterpriseCommonPhoneListName[]	searchCriteriaEnterpriseCommonPhoneListName
protected SearchCriteriaEnterpriseCommonPhoneListNumber[]	searchCriteriaEnterpriseCommonPhoneListNumber
protected Boolean	searchCriteriaModeOr
protected ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor and Description
EnterpriseCommonPhoneListGetListRequest(ServiceProvider serviceProvider)

Method Summary

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

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

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

serviceProvider

@NotNull
protected transient ServiceProvider serviceProvider

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected Boolean searchCriteriaModeOr

searchCriteriaEnterpriseCommonPhoneListName

protected SearchCriteriaEnterpriseCommonPhoneListName[] searchCriteriaEnterpriseCommonPhoneListName

searchCriteriaEnterpriseCommonPhoneListNumber

protected SearchCriteriaEnterpriseCommonPhoneListNumber[] searchCriteriaEnterpriseCommonPhoneListNumber

Constructor Detail

EnterpriseCommonPhoneListGetListRequest

public EnterpriseCommonPhoneListGetListRequest(ServiceProvider serviceProvider)

Method Detail

setServiceProvider

public Enterprise.EnterpriseCommonPhoneListGetListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setResponseSizeLimit

public Enterprise.EnterpriseCommonPhoneListGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public Enterprise.EnterpriseCommonPhoneListGetListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

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>