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

All Implemented Interfaces:

Runnable

Enclosing class:

PreferredCarrier

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

AlpacaLibrary Auto-Generated Java File 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.

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 and Description
protected String	carrier
protected Integer	responseSizeLimit
protected SearchCriteriaDn[]	searchCriteriaDn
protected SearchCriteriaEmailAddress[]	searchCriteriaEmailAddress
protected SearchCriteriaExtension[]	searchCriteriaExtension
protected SearchCriteriaUserFirstName[]	searchCriteriaUserFirstName
protected SearchCriteriaUserId[]	searchCriteriaUserId
protected SearchCriteriaUserLastName[]	searchCriteriaUserLastName

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

log

Constructor Summary

Constructors

Constructor and Description
SystemPreferredCarrierGetUserListRequest(BroadWorksServer broadWorksServer, String carrier)

Method Summary

Modifier and Type	Method and 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, createDocument, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, isMemberOfBundle, isValid, run, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setMemberOfBundle, setRequestId, setResponseClass, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

carrier

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaUserLastName

protected SearchCriteriaUserLastName[] searchCriteriaUserLastName

searchCriteriaUserFirstName

protected SearchCriteriaUserFirstName[] searchCriteriaUserFirstName

searchCriteriaDn

protected SearchCriteriaDn[] searchCriteriaDn

searchCriteriaEmailAddress

protected SearchCriteriaEmailAddress[] searchCriteriaEmailAddress

searchCriteriaUserId

protected SearchCriteriaUserId[] searchCriteriaUserId

searchCriteriaExtension

protected SearchCriteriaExtension[] searchCriteriaExtension

Constructor Detail

SystemPreferredCarrierGetUserListRequest

public SystemPreferredCarrierGetUserListRequest(BroadWorksServer broadWorksServer,
                                                String carrier)

Method Detail

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>