Package co.ecg.alpaca.toolkit.generated

Class Group.GroupPhoneDirectoryGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupPhoneDirectoryGetListRequest

Enclosing class:

Group

public static class Group.GroupPhoneDirectoryGetListRequest
extends Request<Group.GroupPhoneDirectoryGetListResponse>

Request a table containing the phone directory for a group. If the specified 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 the specified group is part of a service provider, the directory includes all users in the group and all entries in the common phone list of the specified group. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The response is either GroupPhoneDirectoryGetListResponse18 or 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	Description
protected @NotNull @Valid Group	group
protected @NotNull Boolean	isExtendedInfoRequested
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserGroup	searchCriteriaExactUserGroup
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaGroupLocationCode[]	searchCriteriaGroupLocationCode
protected @Valid SearchCriteriaImpId[]	searchCriteriaImpId
protected @Valid SearchCriteriaMobilePhoneNumber[]	searchCriteriaMobilePhoneNumber
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid SearchCriteriaYahooId[]	searchCriteriaYahooId

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

log

Constructor Summary

Constructors

Constructor	Description
GroupPhoneDirectoryGetListRequest()
GroupPhoneDirectoryGetListRequest(Group group, Boolean isExtendedInfoRequested)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static Group.GroupPhoneDirectoryGetListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Boolean	getIsExtendedInfoRequested()
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserGroup	getSearchCriteriaExactUserGroup()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaGroupLocationCode[]	getSearchCriteriaGroupLocationCode()
SearchCriteriaImpId[]	getSearchCriteriaImpId()
SearchCriteriaMobilePhoneNumber[]	getSearchCriteriaMobilePhoneNumber()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
SearchCriteriaYahooId[]	getSearchCriteriaYahooId()
Group.GroupPhoneDirectoryGetListRequest	setGroup(Group group)
Group.GroupPhoneDirectoryGetListRequest	setIsExtendedInfoRequested(Boolean isExtendedInfoRequested)
Group.GroupPhoneDirectoryGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaGroupLocationCode(SearchCriteriaGroupLocationCode... searchCriteriaGroupLocationCode)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
Group.GroupPhoneDirectoryGetListRequest	setSearchCriteriaYahooId(SearchCriteriaYahooId... searchCriteriaYahooId)

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 Details

group

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

isExtendedInfoRequested

@NotNull
protected @NotNull Boolean isExtendedInfoRequested

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaGroupLocationCode

@Valid
protected @Valid SearchCriteriaGroupLocationCode[] searchCriteriaGroupLocationCode

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaMobilePhoneNumber

@Valid
protected @Valid SearchCriteriaMobilePhoneNumber[] searchCriteriaMobilePhoneNumber

searchCriteriaEmailAddress

@Valid
protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaYahooId

@Valid
protected @Valid SearchCriteriaYahooId[] searchCriteriaYahooId

searchCriteriaExactUserGroup

@Valid
protected @Valid SearchCriteriaExactUserGroup searchCriteriaExactUserGroup

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaImpId

@Valid
protected @Valid SearchCriteriaImpId[] searchCriteriaImpId

Constructor Details

GroupPhoneDirectoryGetListRequest

public GroupPhoneDirectoryGetListRequest()

GroupPhoneDirectoryGetListRequest

public GroupPhoneDirectoryGetListRequest(Group group,
 Boolean isExtendedInfoRequested)

Method Details

setGroup

public Group.GroupPhoneDirectoryGetListRequest setGroup(Group group)

getGroup

public Group getGroup()

setIsExtendedInfoRequested

public Group.GroupPhoneDirectoryGetListRequest setIsExtendedInfoRequested(Boolean isExtendedInfoRequested)

getIsExtendedInfoRequested

public Boolean getIsExtendedInfoRequested()

setResponseSizeLimit

public Group.GroupPhoneDirectoryGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

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

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

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

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

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

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaGroupLocationCode

public Group.GroupPhoneDirectoryGetListRequest setSearchCriteriaGroupLocationCode(SearchCriteriaGroupLocationCode... searchCriteriaGroupLocationCode)

getSearchCriteriaGroupLocationCode

public SearchCriteriaGroupLocationCode[] getSearchCriteriaGroupLocationCode()

setSearchCriteriaExtension

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

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaMobilePhoneNumber

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

getSearchCriteriaMobilePhoneNumber

public SearchCriteriaMobilePhoneNumber[] getSearchCriteriaMobilePhoneNumber()

setSearchCriteriaEmailAddress

public Group.GroupPhoneDirectoryGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaYahooId

public Group.GroupPhoneDirectoryGetListRequest setSearchCriteriaYahooId(SearchCriteriaYahooId... searchCriteriaYahooId)

getSearchCriteriaYahooId

public SearchCriteriaYahooId[] getSearchCriteriaYahooId()

setSearchCriteriaExactUserGroup

public Group.GroupPhoneDirectoryGetListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup)

getSearchCriteriaExactUserGroup

public SearchCriteriaExactUserGroup getSearchCriteriaExactUserGroup()

setSearchCriteriaExactUserDepartment

public Group.GroupPhoneDirectoryGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

setSearchCriteriaUserId

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

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaImpId

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

getSearchCriteriaImpId

public SearchCriteriaImpId[] getSearchCriteriaImpId()

getEmptyObject

public static Group.GroupPhoneDirectoryGetListRequest 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.GroupPhoneDirectoryGetListResponse>