Package co.ecg.alpaca.toolkit.generated.services

Class PreferredCarrier.SystemPreferredCarrierGetUserListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<PreferredCarrier.SystemPreferredCarrierGetUserListResponse>

co.ecg.alpaca.toolkit.generated.services.PreferredCarrier.SystemPreferredCarrierGetUserListRequest

Enclosing class:

PreferredCarrier

public static class PreferredCarrier.SystemPreferredCarrierGetUserListRequest
extends Request<PreferredCarrier.SystemPreferredCarrierGetUserListResponse>

Requests a list of users using the specified carrier. It is possible to restrict the number of rows returned by specifying various search criteria. Multiple search criteria are logically ANDed together. The response is either a SystemPreferreredCarrierGetUserListResponse 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 @NotNull @Size(min=1,max=80) String	carrier
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected @Valid SearchCriteriaExtension[]	searchCriteriaExtension
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
SystemPreferredCarrierGetUserListRequest()
SystemPreferredCarrierGetUserListRequest(BroadWorksServer broadWorksServer, String carrier)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getCarrier()
static PreferredCarrier.SystemPreferredCarrierGetUserListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaEmailAddress[]	getSearchCriteriaEmailAddress()
SearchCriteriaExtension[]	getSearchCriteriaExtension()
SearchCriteriaUserFirstName[]	getSearchCriteriaUserFirstName()
SearchCriteriaUserId[]	getSearchCriteriaUserId()
SearchCriteriaUserLastName[]	getSearchCriteriaUserLastName()
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setCarrier(String carrier)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setResponseSizeLimit(Integer responseSizeLimit)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)
PreferredCarrier.SystemPreferredCarrierGetUserListRequest	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 Details

carrier

@NotNull
@Size(min=1,
      max=80)
protected @NotNull @Size(min=1,max=80) String carrier

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

searchCriteriaUserId

@Valid
protected @Valid SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExtension

@Valid
protected @Valid SearchCriteriaExtension[] searchCriteriaExtension

Constructor Details

SystemPreferredCarrierGetUserListRequest

public SystemPreferredCarrierGetUserListRequest()

SystemPreferredCarrierGetUserListRequest

public SystemPreferredCarrierGetUserListRequest(BroadWorksServer broadWorksServer,
 String carrier)

Method Details

setCarrier

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setCarrier(String carrier)

getCarrier

public String getCarrier()

setResponseSizeLimit

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaUserLastName

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaUserLastName(SearchCriteriaUserLastName... searchCriteriaUserLastName)

getSearchCriteriaUserLastName

public SearchCriteriaUserLastName[] getSearchCriteriaUserLastName()

setSearchCriteriaUserFirstName

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaUserFirstName(SearchCriteriaUserFirstName... searchCriteriaUserFirstName)

getSearchCriteriaUserFirstName

public SearchCriteriaUserFirstName[] getSearchCriteriaUserFirstName()

setSearchCriteriaDn

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

setSearchCriteriaEmailAddress

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaEmailAddress(SearchCriteriaEmailAddress... searchCriteriaEmailAddress)

getSearchCriteriaEmailAddress

public SearchCriteriaEmailAddress[] getSearchCriteriaEmailAddress()

setSearchCriteriaUserId

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaUserId(SearchCriteriaUserId... searchCriteriaUserId)

getSearchCriteriaUserId

public SearchCriteriaUserId[] getSearchCriteriaUserId()

setSearchCriteriaExtension

public PreferredCarrier.SystemPreferredCarrierGetUserListRequest setSearchCriteriaExtension(SearchCriteriaExtension... searchCriteriaExtension)

getSearchCriteriaExtension

public SearchCriteriaExtension[] getSearchCriteriaExtension()

getEmptyObject

public static PreferredCarrier.SystemPreferredCarrierGetUserListRequest 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<PreferredCarrier.SystemPreferredCarrierGetUserListResponse>