co.ecg.alpaca.toolkit.generated

Class User.UserPhoneDirectoryGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.User.UserPhoneDirectoryGetListRequest

Enclosing class:

User

@GwtIncompatible
public static class User.UserPhoneDirectoryGetListRequest
extends Request<User.UserPhoneDirectoryGetListResponse>

Request a table containing the phone directory for a user's group. If the user's group is part of an enterprise, the directory includes all users in the enterprise and all entries in the enterprise common phone list and the common phone list of the specified group (if includeCommonPhoneList is set to true). If the user's group is part of a service provider, the directory includes all users in the group and all entries in the common phone list (if includeCommonPhoneList is set to true) of the specified group. The response is either UserPhoneDirectoryGetListResponse or ErrorResponse. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias are included in the results. If no search criteria is specified, all results are returned. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.

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 Boolean	includeCommonPhoneList
protected Integer	responseSizeLimit
protected SearchCriteriaDn[]	searchCriteriaDn
protected SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected SearchCriteriaExactCustomContactDirectory	searchCriteriaExactCustomContactDirectory
protected SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
protected SearchCriteriaExtension[]	searchCriteriaExtension
protected SearchCriteriaImpId[]	searchCriteriaImpId
protected SearchCriteriaMobilePhoneNumber[]	searchCriteriaMobilePhoneNumber
protected Boolean	searchCriteriaModeOr
protected SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected SearchCriteriaUserId[]	searchCriteriaUserId
protected SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected BroadWorksUser	user

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

log

Constructor Summary

Constructors

Constructor and Description
UserPhoneDirectoryGetListRequest(BroadWorksUser user, Boolean includeCommonPhoneList)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
BroadWorksUser	getBroadWorksUser()
static User.UserPhoneDirectoryGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
Boolean	getIncludeCommonPhoneList()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactCustomContactDirectory	getSearchCriteriaExactCustomContactDirectory()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
SearchCriteriaMobilePhoneNumber[]	getSearchCriteriaMobilePhoneNumber()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
boolean	searchCriteriaModeOrFlagExist()
User.UserPhoneDirectoryGetListRequest	setFlagSearchCriteriaModeOr()
User.UserPhoneDirectoryGetListRequest	setIncludeCommonPhoneList(Boolean includeCommonPhoneList)
User.UserPhoneDirectoryGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaExactCustomContactDirectory(SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserPhoneDirectoryGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
User.UserPhoneDirectoryGetListRequest	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

includeCommonPhoneList

@NotNull
protected Boolean includeCommonPhoneList

responseSizeLimit

protected Integer responseSizeLimit

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

searchCriteriaEmailAddress

protected SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaExactUserDepartment

protected SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaExactUserGroup

protected SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaExactCustomContactDirectory

protected SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory

searchCriteriaUserId

protected SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaImpId

protected SearchCriteriaImpId[] searchCriteriaImpId

Constructor Detail

UserPhoneDirectoryGetListRequest

public UserPhoneDirectoryGetListRequest(BroadWorksUser user,
                                        Boolean includeCommonPhoneList)

Method Detail

setUser

public User.UserPhoneDirectoryGetListRequest setUser(BroadWorksUser user)

getBroadWorksUser

public BroadWorksUser getBroadWorksUser()

setIncludeCommonPhoneList

public User.UserPhoneDirectoryGetListRequest setIncludeCommonPhoneList(Boolean includeCommonPhoneList)

getIncludeCommonPhoneList

public Boolean getIncludeCommonPhoneList()

setResponseSizeLimit

public User.UserPhoneDirectoryGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public User.UserPhoneDirectoryGetListRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaMobilePhoneNumber

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

getSearchCriteriaMobilePhoneNumber

public SearchCriteriaMobilePhoneNumber[] getSearchCriteriaMobilePhoneNumber()

setSearchCriteriaEmailAddress

public User.UserPhoneDirectoryGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserDepartment

public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaExactUserGroup

public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaExactCustomContactDirectory

public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactCustomContactDirectory(SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory)

getSearchCriteriaExactCustomContactDirectory

public SearchCriteriaExactCustomContactDirectory getSearchCriteriaExactCustomContactDirectory()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaImpId

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

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

getEmptyObject

public static User.UserPhoneDirectoryGetListRequest 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.UserPhoneDirectoryGetListResponse>