co.ecg.alpaca.toolkit.generated

Class User.UserGroupCustomContactDirectoryGetPagedSortedListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserGroupCustomContactDirectoryGetPagedSortedListRequest

Enclosing class:

User

@ChoiceGroup(value="sortByUserLastName") @ChoiceGroup(value="sortByUserFirstName") @ChoiceGroup(value="sortByUserDepartment")
 @GwtIncompatible
public static class User.UserGroupCustomContactDirectoryGetPagedSortedListRequest
extends Request<User.UserGroupCustomContactDirectoryGetPagedSortedListResponse>

Gets a Custom Contact Directory in a group. The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse or 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 user last name, first name, or department.

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 String	name
protected ResponsePagingControl	responsePagingControl
protected SearchCriteriaDepartmentName[]	searchCriteriaDepartmentName
protected SearchCriteriaDn[]	searchCriteriaDn
protected SearchCriteriaExtension[]	searchCriteriaExtension
protected SearchCriteriaImpId[]	searchCriteriaImpId
protected SearchCriteriaMobilePhoneNumber[]	searchCriteriaMobilePhoneNumber
protected Boolean	searchCriteriaModeOr
protected SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected SearchCriteriaUserId[]	searchCriteriaUserId
protected SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected SortByUserDepartment	sortByUserDepartment
protected SortByUserFirstName	sortByUserFirstName
protected SortByUserLastName	sortByUserLastName
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserGroupCustomContactDirectoryGetPagedSortedListRequest(BroadWorksUser user, String name, ResponsePagingControl responsePagingControl)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
String	getName()
ResponsePagingControl	getResponsePagingControl()
SearchCriteriaDepartmentName[]	getSearchCriteriaDepartmentName()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
SearchCriteriaMobilePhoneNumber[]	getSearchCriteriaMobilePhoneNumber()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SortByUserDepartment	getSortByUserDepartment()
SortByUserFirstName	getSortByUserFirstName()
SortByUserLastName	getSortByUserLastName()
boolean	searchCriteriaModeOrFlagExist()
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setFlagSearchCriteriaModeOr()
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setName(String name)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setResponsePagingControl(ResponsePagingControl responsePagingControl)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	setSortByUserLastName(SortByUserLastName sortByUserLastName)
User.UserGroupCustomContactDirectoryGetPagedSortedListRequest	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, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, 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 BroadWorksUser user

name

@NotNull
 @Size(min=1,
      max=40)
protected String name

responsePagingControl

@NotNull
protected ResponsePagingControl responsePagingControl

sortByUserLastName

protected SortByUserLastName sortByUserLastName

sortByUserFirstName

protected SortByUserFirstName sortByUserFirstName

sortByUserDepartment

protected SortByUserDepartment sortByUserDepartment

searchCriteriaModeOr

@AssertTrue
protected Boolean searchCriteriaModeOr

searchCriteriaUserLastName

protected SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

protected SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

protected SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

protected SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaMobilePhoneNumber

protected SearchCriteriaMobilePhoneNumber[] searchCriteriaMobilePhoneNumber

searchCriteriaUserId

protected SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaDepartmentName

protected SearchCriteriaDepartmentName[] searchCriteriaDepartmentName

searchCriteriaImpId

protected SearchCriteriaImpId[] searchCriteriaImpId

Constructor Detail

UserGroupCustomContactDirectoryGetPagedSortedListRequest

public UserGroupCustomContactDirectoryGetPagedSortedListRequest(BroadWorksUser user,
                                                                String name,
                                                                ResponsePagingControl responsePagingControl)

Method Detail

setUser

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setName(String name)

getName

public String getName()

setResponsePagingControl

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl)

getResponsePagingControl

public ResponsePagingControl getResponsePagingControl()

setSortByUserLastName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName)

getSortByUserLastName

public SortByUserLastName getSortByUserLastName()

setSortByUserFirstName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName)

getSortByUserFirstName

public SortByUserFirstName getSortByUserFirstName()

setSortByUserDepartment

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment)

getSortByUserDepartment

public SortByUserDepartment getSortByUserDepartment()

setFlagSearchCriteriaModeOr

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaUserLastName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaMobilePhoneNumber

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)

getSearchCriteriaMobilePhoneNumber

public SearchCriteriaMobilePhoneNumber[] getSearchCriteriaMobilePhoneNumber()

setSearchCriteriaUserId

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaDepartmentName

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaDepartmentName(SearchCriteriaDepartmentName... searchCriteriaDepartmentName)

getSearchCriteriaDepartmentName

public SearchCriteriaDepartmentName[] getSearchCriteriaDepartmentName()

setSearchCriteriaImpId

public User.UserGroupCustomContactDirectoryGetPagedSortedListRequest setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

getEmptyObject

public static User.UserGroupCustomContactDirectoryGetPagedSortedListRequest 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.UserGroupCustomContactDirectoryGetPagedSortedListResponse>