co.ecg.alpaca.toolkit.generated

Class User.UserPersonalPhoneListGetListRequest

java.lang.Object

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

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

All Implemented Interfaces:

Runnable

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.

Field Summary

Fields

Modifier and Type	Field and Description
Integer	responseSizeLimit
boolean	responseSizeLimitIsModified
Boolean	searchCriteriaModeOr
boolean	searchCriteriaModeOrIsModified
SearchCriteriaUserPersonalPhoneListName[]	searchCriteriaUserPersonalPhoneListName
boolean	searchCriteriaUserPersonalPhoneListNameIsModified
SearchCriteriaUserPersonalPhoneListNumber[]	searchCriteriaUserPersonalPhoneListNumber
boolean	searchCriteriaUserPersonalPhoneListNumberIsModified
User	user
boolean	userIsModified

Constructor Summary

Constructors

Constructor and Description
UserPersonalPhoneListGetListRequest(BroadWorksServer bws) Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()
UserPersonalPhoneListGetListRequest(User user)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserPersonalPhoneListName[]	getSearchCriteriaUserPersonalPhoneListName()
SearchCriteriaUserPersonalPhoneListNumber[]	getSearchCriteriaUserPersonalPhoneListNumber()
User	getUser()
User.UserPersonalPhoneListGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserPersonalPhoneListGetListRequest	setSearchCriteriaModeOr(Boolean searchCriteriaModeOr)
User.UserPersonalPhoneListGetListRequest	setSearchCriteriaUserPersonalPhoneListName(SearchCriteriaUserPersonalPhoneListName... searchCriteriaUserPersonalPhoneListName)
User.UserPersonalPhoneListGetListRequest	setSearchCriteriaUserPersonalPhoneListNumber(SearchCriteriaUserPersonalPhoneListNumber... searchCriteriaUserPersonalPhoneListNumber)
User.UserPersonalPhoneListGetListRequest	setUser(User user)

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

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

user

@NotNull
public User user

userIsModified

public transient boolean userIsModified

responseSizeLimit

public Integer responseSizeLimit

responseSizeLimitIsModified

public transient boolean responseSizeLimitIsModified

searchCriteriaModeOr

@AssertTrue
public Boolean searchCriteriaModeOr

searchCriteriaModeOrIsModified

public transient boolean searchCriteriaModeOrIsModified

searchCriteriaUserPersonalPhoneListName

public SearchCriteriaUserPersonalPhoneListName[] searchCriteriaUserPersonalPhoneListName

searchCriteriaUserPersonalPhoneListNameIsModified

public transient boolean searchCriteriaUserPersonalPhoneListNameIsModified

searchCriteriaUserPersonalPhoneListNumber

public SearchCriteriaUserPersonalPhoneListNumber[] searchCriteriaUserPersonalPhoneListNumber

searchCriteriaUserPersonalPhoneListNumberIsModified

public transient boolean searchCriteriaUserPersonalPhoneListNumberIsModified

Constructor Detail

UserPersonalPhoneListGetListRequest

public UserPersonalPhoneListGetListRequest(User user)

UserPersonalPhoneListGetListRequest

public UserPersonalPhoneListGetListRequest(BroadWorksServer bws)

Default Constructor -- Not Guaranteed to work without checking Request validity with isValid()

Parameters:

bws - The BroadWorksServer to use for the Request

Method Detail

setUser

public User.UserPersonalPhoneListGetListRequest setUser(User user)

getUser

public User getUser()

setResponseSizeLimit

public User.UserPersonalPhoneListGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaModeOr

public User.UserPersonalPhoneListGetListRequest setSearchCriteriaModeOr(Boolean searchCriteriaModeOr)

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()

formRequest

public void formRequest()
                 throws RequestException

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

Specified by:

formRequest in class Request<User.UserPersonalPhoneListGetListResponse>

Throws:

RequestException