Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderDnGetSummaryListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<ServiceProvider.ServiceProviderDnGetSummaryListResponse>

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderDnGetSummaryListRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderDnGetSummaryListRequest
extends Request<ServiceProvider.ServiceProviderDnGetSummaryListResponse>

Request a summary table of all DNs in a service provider. Dns assigned to the IMRN pool are not listed in the response. The search can be done using multiple criteria. Only results matching all the search criteria are included in the results. The response is either ServiceProviderDnGetSummaryListResponse or ErrorResponse. The following elements are only used in XS data mode and ignored in AS data mode: searchCriteriaDn, searchCriteriaGroupId

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 @Valid SearchCriteriaDn[]	searchCriteriaDn
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @NotNull @Valid ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderDnGetSummaryListRequest()
ServiceProviderDnGetSummaryListRequest(ServiceProvider serviceProvider)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
static ServiceProvider.ServiceProviderDnGetSummaryListRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
SearchCriteriaDn[]	getSearchCriteriaDn()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderDnGetSummaryListRequest	setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)
ServiceProvider.ServiceProviderDnGetSummaryListRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
ServiceProvider.ServiceProviderDnGetSummaryListRequest	setServiceProvider(ServiceProvider serviceProvider)

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

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaDn

@Valid
protected @Valid SearchCriteriaDn[] searchCriteriaDn

Constructor Details

ServiceProviderDnGetSummaryListRequest

public ServiceProviderDnGetSummaryListRequest()

ServiceProviderDnGetSummaryListRequest

public ServiceProviderDnGetSummaryListRequest(ServiceProvider serviceProvider)

Method Details

setServiceProvider

public ServiceProvider.ServiceProviderDnGetSummaryListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setSearchCriteriaGroupId

public ServiceProvider.ServiceProviderDnGetSummaryListRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaDn

public ServiceProvider.ServiceProviderDnGetSummaryListRequest setSearchCriteriaDn(SearchCriteriaDn... searchCriteriaDn)

getSearchCriteriaDn

public SearchCriteriaDn[] getSearchCriteriaDn()

getEmptyObject

public static ServiceProvider.ServiceProviderDnGetSummaryListRequest 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<ServiceProvider.ServiceProviderDnGetSummaryListResponse>