Package co.ecg.alpaca.toolkit.generated

Class User.UserPersonalPhoneListGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserPersonalPhoneListGetListResponse>

co.ecg.alpaca.toolkit.generated.User.UserPersonalPhoneListGetListRequest

Enclosing class:

User

public static class User.UserPersonalPhoneListGetListRequest
extends Request<User.UserPersonalPhoneListGetListResponse>

Get a user's personal phone list. The response is either a UserPersonalPhoneListGetListResponse 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 Integer	responseSizeLimit
protected @AssertTrue Boolean	searchCriteriaModeOr
protected @Valid SearchCriteriaUserPersonalPhoneListName[]	searchCriteriaUserPersonalPhoneListName
protected @Valid SearchCriteriaUserPersonalPhoneListNumber[]	searchCriteriaUserPersonalPhoneListNumber
protected @NotNull @Valid BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor	Description
UserPersonalPhoneListGetListRequest()
UserPersonalPhoneListGetListRequest(BroadWorksUser user)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPersonalPhoneListGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserPersonalPhoneListName[]	getSearchCriteriaUserPersonalPhoneListName()
SearchCriteriaUserPersonalPhoneListNumber[]	getSearchCriteriaUserPersonalPhoneListNumber()
boolean	searchCriteriaModeOrFlagExist()
User.UserPersonalPhoneListGetListRequest	setFlagSearchCriteriaModeOr()
User.UserPersonalPhoneListGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserPersonalPhoneListGetListRequest	setSearchCriteriaUserPersonalPhoneListName(SearchCriteriaUserPersonalPhoneListName... searchCriteriaUserPersonalPhoneListName)
User.UserPersonalPhoneListGetListRequest	setSearchCriteriaUserPersonalPhoneListNumber(SearchCriteriaUserPersonalPhoneListNumber... searchCriteriaUserPersonalPhoneListNumber)
User.UserPersonalPhoneListGetListRequest	setUser(BroadWorksUser user)

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

user

@NotNull
@Valid
protected transient @NotNull @Valid BroadWorksUser user

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

searchCriteriaUserPersonalPhoneListName

@Valid
protected @Valid SearchCriteriaUserPersonalPhoneListName[] searchCriteriaUserPersonalPhoneListName

searchCriteriaUserPersonalPhoneListNumber

@Valid
protected @Valid SearchCriteriaUserPersonalPhoneListNumber[] searchCriteriaUserPersonalPhoneListNumber

Constructor Details

UserPersonalPhoneListGetListRequest

public UserPersonalPhoneListGetListRequest()

UserPersonalPhoneListGetListRequest

public UserPersonalPhoneListGetListRequest(BroadWorksUser user)

Method Details

setUser

public User.UserPersonalPhoneListGetListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setResponseSizeLimit

public User.UserPersonalPhoneListGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public User.UserPersonalPhoneListGetListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaUserPersonalPhoneListName

public User.UserPersonalPhoneListGetListRequest setSearchCriteriaUserPersonalPhoneListName(SearchCriteriaUserPersonalPhoneListName... searchCriteriaUserPersonalPhoneListName)

getSearchCriteriaUserPersonalPhoneListName

public SearchCriteriaUserPersonalPhoneListName[] getSearchCriteriaUserPersonalPhoneListName()

setSearchCriteriaUserPersonalPhoneListNumber

public User.UserPersonalPhoneListGetListRequest setSearchCriteriaUserPersonalPhoneListNumber(SearchCriteriaUserPersonalPhoneListNumber... searchCriteriaUserPersonalPhoneListNumber)

getSearchCriteriaUserPersonalPhoneListNumber

public SearchCriteriaUserPersonalPhoneListNumber[] getSearchCriteriaUserPersonalPhoneListNumber()

getEmptyObject

public static User.UserPersonalPhoneListGetListRequest 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<User.UserPersonalPhoneListGetListResponse>