Package 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

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	Description
protected @NotNull @Size(min=1,max=80) String	carrier
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaExactServiceProvider	searchCriteriaExactServiceProvider
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaGroupName[]	searchCriteriaGroupName
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemPreferredCarrierGetGroupListRequest()
SystemPreferredCarrierGetGroupListRequest(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.SystemPreferredCarrierGetGroupListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Integer	getResponseSizeLimit()
SearchCriteriaExactServiceProvider	getSearchCriteriaExactServiceProvider()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaGroupName[]	getSearchCriteriaGroupName()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
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)
PreferredCarrier.SystemPreferredCarrierGetGroupListRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

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 Detail

carrier

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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaGroupName

@Valid
protected @Valid SearchCriteriaGroupName[] searchCriteriaGroupName

searchCriteriaExactServiceProvider

@Valid
protected @Valid SearchCriteriaExactServiceProvider searchCriteriaExactServiceProvider

searchCriteriaServiceProviderId

@Valid
protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

Constructor Detail

SystemPreferredCarrierGetGroupListRequest

public SystemPreferredCarrierGetGroupListRequest()

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()

setSearchCriteriaServiceProviderId

public PreferredCarrier.SystemPreferredCarrierGetGroupListRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

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>