Package co.ecg.alpaca.toolkit.generated
Class Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<Enterprise.EnterpriseUserHotelingGuestSettingsGetListResponse>
co.ecg.alpaca.toolkit.generated.Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest
- Enclosing class:
- Enterprise
@ChoiceGroup("sortByUserLastName") @ChoiceGroup("sortByUserFirstName") @ChoiceGroup("sortByUserDepartment") @ChoiceGroup("sortByDn") @ChoiceGroup("sortByExtension") @ChoiceGroup("sortByServiceStatus") @ChoiceGroup("sortByGroupId") public static class Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest extends Request<Enterprise.EnterpriseUserHotelingGuestSettingsGetListResponse>
Get a list of users and their Hoteling Guest service status (active or not active). The response is either EnterpriseUserHotelingGuestSettingsGetListResponse or ErrorResponse. By default, virtual users and non-virtual users that match the selected search criteria are included in the response when "includeVirtualUsers" is present; otherwise, if "includeVirtualUsers" is absent, then only non-virtual users are returned. The search can be performed using multiple criteria. If search criteria is specified, only the users matching all of the specified search criteria are included in the response. If no search criteria is specified, all results are returned.
- Author:
- AlpacaGenerator
-
Nested Class Summary
Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
Request.Protocol
-
Field Summary
-
Constructor Summary
Constructors Constructor Description EnterpriseUserHotelingGuestSettingsGetListRequest()
EnterpriseUserHotelingGuestSettingsGetListRequest(Enterprise enterprise, ResponsePagingControl responsePagingControl)
-
Method Summary
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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate
-
Field Details
-
enterprise
-
responsePagingControl
-
sortByUserLastName
-
sortByUserFirstName
-
sortByUserDepartment
-
sortByDn
-
sortByExtension
-
sortByServiceStatus
-
sortByGroupId
-
includeVirtualUsers
@AssertTrue protected @AssertTrue java.lang.Boolean includeVirtualUsers -
searchCriteriaUserLastName
-
searchCriteriaUserFirstName
-
searchCriteriaUserId
-
searchCriteriaDn
-
searchCriteriaExtension
-
searchCriteriaEmailAddress
-
searchCriteriaExactUserDepartment
-
searchCriteriaExactUserInTrunkGroup
-
-
Constructor Details
-
EnterpriseUserHotelingGuestSettingsGetListRequest
public EnterpriseUserHotelingGuestSettingsGetListRequest() -
EnterpriseUserHotelingGuestSettingsGetListRequest
public EnterpriseUserHotelingGuestSettingsGetListRequest(Enterprise enterprise, ResponsePagingControl responsePagingControl)
-
-
Method Details
-
setEnterprise
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setEnterprise(Enterprise enterprise) -
getEnterprise
-
setResponsePagingControl
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl) -
getResponsePagingControl
-
setSortByUserLastName
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserLastName(SortByUserLastName sortByUserLastName) -
getSortByUserLastName
-
setSortByUserFirstName
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserFirstName(SortByUserFirstName sortByUserFirstName) -
getSortByUserFirstName
-
setSortByUserDepartment
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByUserDepartment(SortByUserDepartment sortByUserDepartment) -
getSortByUserDepartment
-
setSortByDn
-
getSortByDn
-
setSortByExtension
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByExtension(SortByExtension sortByExtension) -
getSortByExtension
-
setSortByServiceStatus
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByServiceStatus(SortByServiceStatus sortByServiceStatus) -
getSortByServiceStatus
-
setSortByGroupId
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSortByGroupId(SortByGroupId sortByGroupId) -
getSortByGroupId
-
setFlagIncludeVirtualUsers
-
includeVirtualUsersFlagExist
public boolean includeVirtualUsersFlagExist() -
getIncludeVirtualUsers
public java.lang.Boolean getIncludeVirtualUsers() -
setSearchCriteriaUserLastName
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName) -
getSearchCriteriaUserLastName
-
setSearchCriteriaUserFirstName
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName) -
getSearchCriteriaUserFirstName
-
setSearchCriteriaUserId
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId) -
getSearchCriteriaUserId
-
setSearchCriteriaDn
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn) -
getSearchCriteriaDn
-
setSearchCriteriaExtension
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension) -
getSearchCriteriaExtension
-
setSearchCriteriaEmailAddress
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress) -
getSearchCriteriaEmailAddress
-
setSearchCriteriaExactUserDepartment
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment) -
getSearchCriteriaExactUserDepartment
-
setSearchCriteriaExactUserInTrunkGroup
public Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup) -
getSearchCriteriaExactUserInTrunkGroup
-
getEmptyObject
public static Enterprise.EnterpriseUserHotelingGuestSettingsGetListRequest 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 classRequest<Enterprise.EnterpriseUserHotelingGuestSettingsGetListResponse>
-