co.ecg.alpaca.toolkit.generated

Class Group.GroupCustomContactDirectoryGetRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<Group.GroupCustomContactDirectoryGetResponse>

co.ecg.alpaca.toolkit.generated.Group.GroupCustomContactDirectoryGetRequest

All Implemented Interfaces:

Runnable

Enclosing class:

Group

@GwtIncompatible
public static class Group.GroupCustomContactDirectoryGetRequest
extends Request<Group.GroupCustomContactDirectoryGetResponse>

AlpacaLibrary Auto-Generated Java File Gets a Custom Contact Directory in a group. The response is either GroupCustomContactDirectoryGetResponse17 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. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned.

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 Group	group
protected String	name
protected Integer	responseSizeLimit
protected SearchCriteriaDn[]	searchCriteriaDn
protected SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected SearchCriteriaExtension[]	searchCriteriaExtension
protected SearchCriteriaImpId[]	searchCriteriaImpId
protected SearchCriteriaMobilePhoneNumber[]	searchCriteriaMobilePhoneNumber
protected Boolean	searchCriteriaModeOr
protected SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected SearchCriteriaUserId[]	searchCriteriaUserId
protected SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor and Description
GroupCustomContactDirectoryGetRequest(Group group, String name)

Method Summary

Modifier and Type	Method and Description
void	formRequest() Forms the XML Document for this Request Object.
static Group.GroupCustomContactDirectoryGetRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
Group	getGroup()
String	getName()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
SearchCriteriaMobilePhoneNumber[]	getSearchCriteriaMobilePhoneNumber()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
boolean	searchCriteriaModeOrFlagExist()
Group.GroupCustomContactDirectoryGetRequest	setFlagSearchCriteriaModeOr()
Group.GroupCustomContactDirectoryGetRequest	setGroup(Group group)
Group.GroupCustomContactDirectoryGetRequest	setName(String name)
Group.GroupCustomContactDirectoryGetRequest	setResponseSizeLimit(Integer responseSizeLimit)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

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

group

@NotNull
protected transient Group group

name

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

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

searchCriteriaUserId

protected SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExactUserDepartment

protected SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaImpId

protected SearchCriteriaImpId[] searchCriteriaImpId

Constructor Detail

GroupCustomContactDirectoryGetRequest

public GroupCustomContactDirectoryGetRequest(Group group,
                                             String name)

Method Detail

setGroup

public Group.GroupCustomContactDirectoryGetRequest setGroup(Group group)

getGroup

public Group getGroup()

setName

public Group.GroupCustomContactDirectoryGetRequest setName(String name)

getName

public String getName()

setResponseSizeLimit

public Group.GroupCustomContactDirectoryGetRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setFlagSearchCriteriaModeOr

public Group.GroupCustomContactDirectoryGetRequest setFlagSearchCriteriaModeOr()

searchCriteriaModeOrFlagExist

public boolean searchCriteriaModeOrFlagExist()

setSearchCriteriaUserLastName

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaExtension

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaMobilePhoneNumber

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)

getSearchCriteriaMobilePhoneNumber

public SearchCriteriaMobilePhoneNumber[] getSearchCriteriaMobilePhoneNumber()

setSearchCriteriaUserId

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExactUserDepartment

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaImpId

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

getEmptyObject

public static Group.GroupCustomContactDirectoryGetRequest 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<Group.GroupCustomContactDirectoryGetResponse>