Package 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
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 criteria 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
FieldsModifier and TypeFieldDescriptionprotected @NotNull Booleanprotected Integerprotected @Valid SearchCriteriaDn[]protected @Valid SearchCriteriaEmailAddress[]protected @Valid SearchCriteriaExactCustomContactDirectoryprotected @Valid SearchCriteriaExactUserDepartmentprotected @Valid SearchCriteriaExactUserGroupprotected @Valid SearchCriteriaExtension[]protected @Valid SearchCriteriaImpId[]protected @Valid SearchCriteriaMobilePhoneNumber[]protected @AssertTrue Booleanprotected @Valid SearchCriteriaUserFirstName[]protected @Valid SearchCriteriaUserId[]protected @Valid SearchCriteriaUserLastName[]protected @NotNull @Valid BroadWorksUser -
Constructor Summary
ConstructorsConstructorDescriptionUserPhoneDirectoryGetListRequest(BroadWorksUser user, Boolean includeCommonPhoneList) -
Method Summary
Modifier and TypeMethodDescriptionvoidForms the XML Document for this Request Object.getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.booleansetIncludeCommonPhoneList(Boolean includeCommonPhoneList) setResponseSizeLimit(Integer responseSizeLimit) setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn) setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress) setSearchCriteriaExactCustomContactDirectory(SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory) setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment) setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup) setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension) setSearchCriteriaImpId(SearchCriteriaImpId... searchCriteriaImpId) setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber) setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName) setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId) setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName) setUser(BroadWorksUser user) 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
-
Field Details
-
user
-
includeCommonPhoneList
-
responseSizeLimit
-
searchCriteriaModeOr
-
searchCriteriaUserLastName
-
searchCriteriaUserFirstName
-
searchCriteriaDn
-
searchCriteriaExtension
-
searchCriteriaMobilePhoneNumber
-
searchCriteriaEmailAddress
-
searchCriteriaExactUserDepartment
-
searchCriteriaExactUserGroup
-
searchCriteriaExactCustomContactDirectory
@Valid protected @Valid SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory -
searchCriteriaUserId
-
searchCriteriaImpId
-
-
Constructor Details
-
UserPhoneDirectoryGetListRequest
public UserPhoneDirectoryGetListRequest() -
UserPhoneDirectoryGetListRequest
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setIncludeCommonPhoneList
public User.UserPhoneDirectoryGetListRequest setIncludeCommonPhoneList(Boolean includeCommonPhoneList) -
getIncludeCommonPhoneList
-
setResponseSizeLimit
-
getResponseSizeLimit
-
setFlagSearchCriteriaModeOr
-
searchCriteriaModeOrFlagExist
public boolean searchCriteriaModeOrFlagExist() -
getSearchCriteriaModeOr
-
setSearchCriteriaUserLastName
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName) -
getSearchCriteriaUserLastName
-
setSearchCriteriaUserFirstName
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName) -
getSearchCriteriaUserFirstName
-
setSearchCriteriaDn
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn) -
getSearchCriteriaDn
-
setSearchCriteriaExtension
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension) -
getSearchCriteriaExtension
-
setSearchCriteriaMobilePhoneNumber
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaMobilePhoneNumber(SearchCriteriaMobilePhoneNumber... searchCriteriaMobilePhoneNumber) -
getSearchCriteriaMobilePhoneNumber
-
setSearchCriteriaEmailAddress
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress) -
getSearchCriteriaEmailAddress
-
setSearchCriteriaExactUserDepartment
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment) -
getSearchCriteriaExactUserDepartment
-
setSearchCriteriaExactUserGroup
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactUserGroup(SearchCriteriaExactUserGroup searchCriteriaExactUserGroup) -
getSearchCriteriaExactUserGroup
-
setSearchCriteriaExactCustomContactDirectory
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaExactCustomContactDirectory(SearchCriteriaExactCustomContactDirectory searchCriteriaExactCustomContactDirectory) -
getSearchCriteriaExactCustomContactDirectory
-
setSearchCriteriaUserId
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId) -
getSearchCriteriaUserId
-
setSearchCriteriaImpId
public User.UserPhoneDirectoryGetListRequest setSearchCriteriaImpId(SearchCriteriaImpId... 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:
formRequestin classRequest<User.UserPhoneDirectoryGetListResponse>
-