co.ecg.alpaca.toolkit.generated.services

Class PreferredCarrier.SystemPreferredCarrierGetGroupListRequest

java.lang.Object

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

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

Enclosing class:

PreferredCarrier

@GwtIncompatible
public static class PreferredCarrier.SystemPreferredCarrierGetGroupListRequest
extends Request<PreferredCarrier.SystemPreferredCarrierGetGroupListResponse>

Requests a list of groups 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 SystemPreferredCarrierGetGroupListResponse 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 and Description
protected String	carrier
protected Integer	responseSizeLimit
protected SearchCriteriaExactServiceProvider	searchCriteriaExactServiceProvider
protected SearchCriteriaGroupId[]	searchCriteriaGroupId
protected SearchCriteriaGroupName[]	searchCriteriaGroupName

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

log

Constructor Summary

Constructors

Constructor and Description
SystemPreferredCarrierGetGroupListRequest(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.SystemPreferredCarrierGetGroupListRequest	getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaExactServiceProvider	getSearchCriteriaExactServiceProvider()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaGroupName[]	getSearchCriteriaGroupName()
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setCarrier(String carrier)
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setResponseSizeLimit(Integer responseSizeLimit)
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)

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

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createTextElement, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getResponseClass, getRootElement, getValidationErrorsAsString, isMemberOfBundle, isValid, 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

searchCriteriaGroupId

protected SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaGroupName

protected SearchCriteriaGroupName[] searchCriteriaGroupName

searchCriteriaExactServiceProvider

protected SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider

Constructor Detail

SystemPreferredCarrierGetGroupListRequest

public SystemPreferredCarrierGetGroupListRequest(BroadWorksServer broadWorksServer,
                                                 String carrier)

Method Detail

setCarrier

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setCarrier(String carrier)

getCarrier

public String getCarrier()

setResponseSizeLimit

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaGroupId

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaGroupName

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setSearchCriteriaGroupName(SearchCriteriaGroupName... searchCriteriaGroupName)

getSearchCriteriaGroupName

public SearchCriteriaGroupName[] getSearchCriteriaGroupName()

setSearchCriteriaExactServiceProvider

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setSearchCriteriaExactServiceProvider(SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider)

getSearchCriteriaExactServiceProvider

public SearchCriteriaExactServiceProvider getSearchCriteriaExactServiceProvider()

getEmptyObject

public static PreferredCarrier.SystemPreferredCarrierGetGroupListRequest 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.SystemPreferredCarrierGetGroupListResponse>