Package 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

Enclosing class:

Group

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

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. The Receptionist Note column is only populated in AS mode; and populated only if the user sending the request is a the owner of this Receptionist Note and a Note exists.

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	Description
protected @NotNull @Valid Group	group
protected @NotNull @Size(min=1,max=40) String	name
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaImpId[]	searchCriteriaImpId
protected @Valid SearchCriteriaMobilePhoneNumber[]	searchCriteriaMobilePhoneNumber
protected @AssertTrue Boolean	searchCriteriaModeOr
protected @Valid SearchCriteriaReceptionistNote[]	searchCriteriaReceptionistNote
protected @Valid SearchCriteriaTitle[]	searchCriteriaTitle
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCustomContactDirectoryGetRequest()
GroupCustomContactDirectoryGetRequest(Group group, String name)

Method Summary

Modifier and Type	Method	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()
Boolean	getSearchCriteriaModeOr()
SearchCriteriaReceptionistNote[]	getSearchCriteriaReceptionistNote()
SearchCriteriaTitle[]	getSearchCriteriaTitle()
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	setSearchCriteriaReceptionistNote(SearchCriteriaReceptionistNote... searchCriteriaReceptionistNote)
Group.GroupCustomContactDirectoryGetRequest	setSearchCriteriaTitle(SearchCriteriaTitle... searchCriteriaTitle)
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, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

name

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaModeOr

@AssertTrue
protected @AssertTrue Boolean searchCriteriaModeOr

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaMobilePhoneNumber

@Valid
protected @Valid SearchCriteriaMobilePhoneNumber[] searchCriteriaMobilePhoneNumber

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaImpId

@Valid
protected @Valid SearchCriteriaImpId[] searchCriteriaImpId

searchCriteriaTitle

@Valid
protected @Valid SearchCriteriaTitle[] searchCriteriaTitle

searchCriteriaReceptionistNote

@Valid
protected @Valid SearchCriteriaReceptionistNote[] searchCriteriaReceptionistNote

Constructor Detail

GroupCustomContactDirectoryGetRequest

public GroupCustomContactDirectoryGetRequest()

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()

getSearchCriteriaModeOr

public Boolean getSearchCriteriaModeOr()

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()

setSearchCriteriaTitle

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaTitle(SearchCriteriaTitle... searchCriteriaTitle)

getSearchCriteriaTitle

public SearchCriteriaTitle[] getSearchCriteriaTitle()

setSearchCriteriaReceptionistNote

public Group.GroupCustomContactDirectoryGetRequest setSearchCriteriaReceptionistNote(SearchCriteriaReceptionistNote... searchCriteriaReceptionistNote)

getSearchCriteriaReceptionistNote

public SearchCriteriaReceptionistNote[] getSearchCriteriaReceptionistNote()

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>