co.ecg.alpaca.toolkit.generated

Class User.UserGroupCommonPhoneListGetPagedSortedListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserGroupCommonPhoneListGetPagedSortedListRequest

Enclosing class:

User

@ChoiceGroup(value="sortByGroupCommonPhoneListNumber") @ChoiceGroup(value="sortByGroupCommonPhoneListName")
 @GwtIncompatible
public static class User.UserGroupCommonPhoneListGetPagedSortedListRequest
extends Request<User.UserGroupCommonPhoneListGetPagedSortedListResponse>

Get a user's group's common phone list. The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse 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.

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 and Description
protected ResponsePagingControl	responsePagingControl
protected SearchCriteriaGroupCommonPhoneListName[]	searchCriteriaGroupCommonPhoneListName
protected SearchCriteriaGroupCommonPhoneListNumber[]	searchCriteriaGroupCommonPhoneListNumber
protected Boolean	searchCriteriaModeOr
protected SortByGroupCommonPhoneListName	sortByGroupCommonPhoneListName
protected SortByGroupCommonPhoneListNumber	sortByGroupCommonPhoneListNumber
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserGroupCommonPhoneListGetPagedSortedListRequest(BroadWorksUser user, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserGroupCommonPhoneListGetPagedSortedListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaGroupCommonPhoneListName[]	getSearchCriteriaGroupCommonPhoneListName()
SearchCriteriaGroupCommonPhoneListNumber[]	getSearchCriteriaGroupCommonPhoneListNumber()
Boolean	getSearchCriteriaModeOr()
SortByGroupCommonPhoneListName	getSortByGroupCommonPhoneListName()
SortByGroupCommonPhoneListNumber	getSortByGroupCommonPhoneListNumber()
boolean	searchCriteriaModeOrFlagExist()
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setFlagSearchCriteriaModeOr()
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setSearchCriteriaGroupCommonPhoneListName(SearchCriteriaGroupCommonPhoneListName... searchCriteriaGroupCommonPhoneListName)
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setSearchCriteriaGroupCommonPhoneListNumber(SearchCriteriaGroupCommonPhoneListNumber... searchCriteriaGroupCommonPhoneListNumber)
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setSortByGroupCommonPhoneListName(SortByGroupCommonPhoneListName sortByGroupCommonPhoneListName)
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setSortByGroupCommonPhoneListNumber(SortByGroupCommonPhoneListNumber sortByGroupCommonPhoneListNumber)
User.UserGroupCommonPhoneListGetPagedSortedListRequest	setUser(BroadWorksUser user)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, 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 BroadWorksUser user

responsePagingControl

@NotNull
protected ResponsePagingControl responsePagingControl

sortByGroupCommonPhoneListNumber

protected SortByGroupCommonPhoneListNumber sortByGroupCommonPhoneListNumber

sortByGroupCommonPhoneListName

protected SortByGroupCommonPhoneListName sortByGroupCommonPhoneListName

searchCriteriaModeOr

@AssertTrue
protected Boolean searchCriteriaModeOr

searchCriteriaGroupCommonPhoneListName

protected SearchCriteriaGroupCommonPhoneListName[] searchCriteriaGroupCommonPhoneListName

searchCriteriaGroupCommonPhoneListNumber

protected SearchCriteriaGroupCommonPhoneListNumber[] searchCriteriaGroupCommonPhoneListNumber

Constructor Detail

UserGroupCommonPhoneListGetPagedSortedListRequest

public UserGroupCommonPhoneListGetPagedSortedListRequest(BroadWorksUser user,
                                                         ResponsePagingControl responsePagingControl)

Method Detail

setUser

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setResponsePagingControl

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByGroupCommonPhoneListNumber

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setSortByGroupCommonPhoneListNumber(SortByGroupCommonPhoneListNumber sortByGroupCommonPhoneListNumber)

getSortByGroupCommonPhoneListNumber

public SortByGroupCommonPhoneListNumber getSortByGroupCommonPhoneListNumber()

setSortByGroupCommonPhoneListName

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setSortByGroupCommonPhoneListName(SortByGroupCommonPhoneListName sortByGroupCommonPhoneListName)

getSortByGroupCommonPhoneListName

public SortByGroupCommonPhoneListName getSortByGroupCommonPhoneListName()

setFlagSearchCriteriaModeOr

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaGroupCommonPhoneListName

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setSearchCriteriaGroupCommonPhoneListName(SearchCriteriaGroupCommonPhoneListName... searchCriteriaGroupCommonPhoneListName)

getSearchCriteriaGroupCommonPhoneListName

public SearchCriteriaGroupCommonPhoneListName[] getSearchCriteriaGroupCommonPhoneListName()

setSearchCriteriaGroupCommonPhoneListNumber

public User.UserGroupCommonPhoneListGetPagedSortedListRequest setSearchCriteriaGroupCommonPhoneListNumber(SearchCriteriaGroupCommonPhoneListNumber... searchCriteriaGroupCommonPhoneListNumber)

getSearchCriteriaGroupCommonPhoneListNumber

public SearchCriteriaGroupCommonPhoneListNumber[] getSearchCriteriaGroupCommonPhoneListNumber()

getEmptyObject

public static User.UserGroupCommonPhoneListGetPagedSortedListRequest 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.UserGroupCommonPhoneListGetPagedSortedListResponse>