co.ecg.alpaca.toolkit.generated

Class User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest

All Implemented Interfaces:

Runnable

Enclosing class:

User

@GwtIncompatible
public static class User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest
extends Request<User.UserEnterpriseCommonPhoneListGetPagedSortedListResponse>

AlpacaLibrary Auto-Generated Java File Get an enterprise's common phone list for a user. The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse 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. The sort can be done on the name or the number in the common phone list.

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 ResponsePagingControl	responsePagingControl
protected SearchCriteriaEnterpriseCommonPhoneListName[]	searchCriteriaEnterpriseCommonPhoneListName
protected SearchCriteriaEnterpriseCommonPhoneListNumber[]	searchCriteriaEnterpriseCommonPhoneListNumber
protected Boolean	searchCriteriaModeOr
protected SortByEnterpriseCommonPhoneListName	sortByEnterpriseCommonPhoneListName
protected SortByEnterpriseCommonPhoneListNumber	sortByEnterpriseCommonPhoneListNumber
protected User	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserEnterpriseCommonPhoneListGetPagedSortedListRequest(User user, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
static User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaEnterpriseCommonPhoneListName[]	getSearchCriteriaEnterpriseCommonPhoneListName()
SearchCriteriaEnterpriseCommonPhoneListNumber[]	getSearchCriteriaEnterpriseCommonPhoneListNumber()
SortByEnterpriseCommonPhoneListName	getSortByEnterpriseCommonPhoneListName()
SortByEnterpriseCommonPhoneListNumber	getSortByEnterpriseCommonPhoneListNumber()
User	getUser()
boolean	searchCriteriaModeOrFlagExist()
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setFlagSearchCriteriaModeOr()
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setSearchCriteriaEnterpriseCommonPhoneListName(SearchCriteriaEnterpriseCommonPhoneListName... searchCriteriaEnterpriseCommonPhoneListName)
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setSearchCriteriaEnterpriseCommonPhoneListNumber(SearchCriteriaEnterpriseCommonPhoneListNumber... searchCriteriaEnterpriseCommonPhoneListNumber)
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setSortByEnterpriseCommonPhoneListName(SortByEnterpriseCommonPhoneListName sortByEnterpriseCommonPhoneListName)
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setSortByEnterpriseCommonPhoneListNumber(SortByEnterpriseCommonPhoneListNumber sortByEnterpriseCommonPhoneListNumber)
User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest	setUser(User user)

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

user

@NotNull
protected transient User user

responsePagingControl

@NotNull
protected ResponsePagingControl responsePagingControl

sortByEnterpriseCommonPhoneListNumber

protected SortByEnterpriseCommonPhoneListNumber sortByEnterpriseCommonPhoneListNumber

sortByEnterpriseCommonPhoneListName

protected SortByEnterpriseCommonPhoneListName sortByEnterpriseCommonPhoneListName

searchCriteriaModeOr

@AssertTrue
protected Boolean searchCriteriaModeOr

searchCriteriaEnterpriseCommonPhoneListName

protected SearchCriteriaEnterpriseCommonPhoneListName[] searchCriteriaEnterpriseCommonPhoneListName

searchCriteriaEnterpriseCommonPhoneListNumber

protected SearchCriteriaEnterpriseCommonPhoneListNumber[] searchCriteriaEnterpriseCommonPhoneListNumber

Constructor Detail

UserEnterpriseCommonPhoneListGetPagedSortedListRequest

public UserEnterpriseCommonPhoneListGetPagedSortedListRequest(User user,
                                                              ResponsePagingControl responsePagingControl)

Method Detail

setUser

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setUser(User user)

getUser

public User getUser()

setResponsePagingControl

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByEnterpriseCommonPhoneListNumber

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setSortByEnterpriseCommonPhoneListNumber(SortByEnterpriseCommonPhoneListNumber sortByEnterpriseCommonPhoneListNumber)

getSortByEnterpriseCommonPhoneListNumber

public SortByEnterpriseCommonPhoneListNumber getSortByEnterpriseCommonPhoneListNumber()

setSortByEnterpriseCommonPhoneListName

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setSortByEnterpriseCommonPhoneListName(SortByEnterpriseCommonPhoneListName sortByEnterpriseCommonPhoneListName)

getSortByEnterpriseCommonPhoneListName

public SortByEnterpriseCommonPhoneListName getSortByEnterpriseCommonPhoneListName()

setFlagSearchCriteriaModeOr

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

setSearchCriteriaEnterpriseCommonPhoneListName

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setSearchCriteriaEnterpriseCommonPhoneListName(SearchCriteriaEnterpriseCommonPhoneListName... searchCriteriaEnterpriseCommonPhoneListName)

getSearchCriteriaEnterpriseCommonPhoneListName

public SearchCriteriaEnterpriseCommonPhoneListName[] getSearchCriteriaEnterpriseCommonPhoneListName()

setSearchCriteriaEnterpriseCommonPhoneListNumber

public User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest setSearchCriteriaEnterpriseCommonPhoneListNumber(SearchCriteriaEnterpriseCommonPhoneListNumber... searchCriteriaEnterpriseCommonPhoneListNumber)

getSearchCriteriaEnterpriseCommonPhoneListNumber

public SearchCriteriaEnterpriseCommonPhoneListNumber[] getSearchCriteriaEnterpriseCommonPhoneListNumber()

getEmptyObject

public static User.UserEnterpriseCommonPhoneListGetPagedSortedListRequest 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.UserEnterpriseCommonPhoneListGetPagedSortedListResponse>