Package co.ecg.alpaca.toolkit.generated

Class User.UserGetListInServiceProviderRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<User.UserGetListInServiceProviderResponse>

co.ecg.alpaca.toolkit.generated.User.UserGetListInServiceProviderRequest

Enclosing class:

User

@ChoiceGroup("serviceProvider") @ChoiceGroup("serviceProviderExternalId")
public static class User.UserGetListInServiceProviderRequest
extends Request<User.UserGetListInServiceProviderResponse>

Request the list of users in a service provider or enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExternalId The response is either a UserGetListInServiceProviderResponse or an 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExactUserDepartment	searchCriteriaExactUserDepartment
protected @Valid SearchCriteriaExactUserInTrunkGroup	searchCriteriaExactUserInTrunkGroup
protected @Valid SearchCriteriaExactUserPersonId	searchCriteriaExactUserPersonId
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
protected @Valid SearchCriteriaUserExternalId[]	searchCriteriaUserExternalId
protected @Valid SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected @Valid SearchCriteriaUserId[]	searchCriteriaUserId
protected @Valid SearchCriteriaUserLastName[]	searchCriteriaUserLastName
protected @Valid ServiceProvider	serviceProvider
protected @Size(max=36) String	serviceProviderExternalId

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

log

Constructor Summary

Constructors

Constructor	Description
UserGetListInServiceProviderRequest()
UserGetListInServiceProviderRequest(ServiceProvider serviceProvider)
UserGetListInServiceProviderRequest(BroadWorksServer broadWorksServer)
UserGetListInServiceProviderRequest(BroadWorksServer broadWorksServer, String serviceProviderExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExactUserDepartment	getSearchCriteriaExactUserDepartment()
SearchCriteriaExactUserInTrunkGroup	getSearchCriteriaExactUserInTrunkGroup()
SearchCriteriaExactUserPersonId	getSearchCriteriaExactUserPersonId()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserExternalId[]	getSearchCriteriaUserExternalId()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
ServiceProvider	getServiceProvider()
String	getServiceProviderExternalId()
User.UserGetListInServiceProviderRequest	setResponseSizeLimit(Integer responseSizeLimit)
User.UserGetListInServiceProviderRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
User.UserGetListInServiceProviderRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
User.UserGetListInServiceProviderRequest	setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)
User.UserGetListInServiceProviderRequest	setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)
User.UserGetListInServiceProviderRequest	setSearchCriteriaExactUserPersonId(SearchCriteriaExactUserPersonId searchCriteriaExactUserPersonId)
User.UserGetListInServiceProviderRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
User.UserGetListInServiceProviderRequest	setSearchCriteriaUserExternalId(SearchCriteriaUserExternalId... searchCriteriaUserExternalId)
User.UserGetListInServiceProviderRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
User.UserGetListInServiceProviderRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
User.UserGetListInServiceProviderRequest	setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)
User.UserGetListInServiceProviderRequest	setServiceProvider(ServiceProvider serviceProvider)
User.UserGetListInServiceProviderRequest	setServiceProviderExternalId(String serviceProviderExternalId)

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

serviceProvider

@Valid
protected transient @Valid ServiceProvider serviceProvider

serviceProviderExternalId

@Size(max=36)
protected @Size(max=36) String serviceProviderExternalId

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

@Valid
protected @Valid SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

@Valid
protected @Valid SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

searchCriteriaEmailAddress

@Valid
protected @Valid SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaExactUserInTrunkGroup

@Valid
protected @Valid SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaUserExternalId

@Valid
protected @Valid SearchCriteriaUserExternalId[] searchCriteriaUserExternalId

searchCriteriaExactUserPersonId

@Valid
protected @Valid SearchCriteriaExactUserPersonId searchCriteriaExactUserPersonId

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

searchCriteriaExactUserDepartment

@Valid
protected @Valid SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment

Constructor Details

UserGetListInServiceProviderRequest

public UserGetListInServiceProviderRequest()

UserGetListInServiceProviderRequest

public UserGetListInServiceProviderRequest(BroadWorksServer broadWorksServer)

UserGetListInServiceProviderRequest

public UserGetListInServiceProviderRequest(ServiceProvider serviceProvider)

UserGetListInServiceProviderRequest

public UserGetListInServiceProviderRequest(BroadWorksServer broadWorksServer,
 String serviceProviderExternalId)

Method Details

setServiceProvider

public User.UserGetListInServiceProviderRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setServiceProviderExternalId

public User.UserGetListInServiceProviderRequest setServiceProviderExternalId(String serviceProviderExternalId)

getServiceProviderExternalId

public String getServiceProviderExternalId()

setResponseSizeLimit

public User.UserGetListInServiceProviderRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public User.UserGetListInServiceProviderRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public User.UserGetListInServiceProviderRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public User.UserGetListInServiceProviderRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaEmailAddress

public User.UserGetListInServiceProviderRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaExactUserInTrunkGroup

public User.UserGetListInServiceProviderRequest setSearchCriteriaExactUserInTrunkGroup(SearchCriteriaExactUserInTrunkGroup searchCriteriaExactUserInTrunkGroup)

getSearchCriteriaExactUserInTrunkGroup

public SearchCriteriaExactUserInTrunkGroup getSearchCriteriaExactUserInTrunkGroup()

setSearchCriteriaUserId

public User.UserGetListInServiceProviderRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaUserExternalId

public User.UserGetListInServiceProviderRequest setSearchCriteriaUserExternalId(SearchCriteriaUserExternalId... searchCriteriaUserExternalId)

getSearchCriteriaUserExternalId

public SearchCriteriaUserExternalId[] getSearchCriteriaUserExternalId()

setSearchCriteriaExactUserPersonId

public User.UserGetListInServiceProviderRequest setSearchCriteriaExactUserPersonId(SearchCriteriaExactUserPersonId searchCriteriaExactUserPersonId)

getSearchCriteriaExactUserPersonId

public SearchCriteriaExactUserPersonId getSearchCriteriaExactUserPersonId()

setSearchCriteriaExtension

public User.UserGetListInServiceProviderRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

setSearchCriteriaExactUserDepartment

public User.UserGetListInServiceProviderRequest setSearchCriteriaExactUserDepartment(SearchCriteriaExactUserDepartment searchCriteriaExactUserDepartment)

getSearchCriteriaExactUserDepartment

public SearchCriteriaExactUserDepartment getSearchCriteriaExactUserDepartment()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<User.UserGetListInServiceProviderResponse>