Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderGetListRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderGetListRequest
extends Request<ServiceProvider.ServiceProviderGetListResponse>

Request a list of service providers and/or enterprises in the system. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. If reseller administrator sends the request, searchCriteriaResellerId is ignored. Service providers/enterprise within the administrator's reseller meeting the search criteria are returned. The response is either a ServiceProviderGetListResponse or an ErrorResponse. The following data elements are only used in AS data mode: searchCriteriaResellerId

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 Boolean	isEnterprise
protected Integer	responseSizeLimit
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId
protected @Valid SearchCriteriaServiceProviderName[]	searchCriteriaServiceProviderName

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderGetListRequest()
ServiceProviderGetListRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getIsEnterprise()
Integer	getResponseSizeLimit()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
SearchCriteriaServiceProviderName[]	getSearchCriteriaServiceProviderName()
ServiceProvider.ServiceProviderGetListRequest	setIsEnterprise(Boolean isEnterprise)
ServiceProvider.ServiceProviderGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
ServiceProvider.ServiceProviderGetListRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)
ServiceProvider.ServiceProviderGetListRequest	setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)
ServiceProvider.ServiceProviderGetListRequest	setSearchCriteriaServiceProviderName(SearchCriteriaServiceProviderName... searchCriteriaServiceProviderName)

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

isEnterprise

protected Boolean isEnterprise

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaServiceProviderId

@Valid
protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaServiceProviderName

@Valid
protected @Valid SearchCriteriaServiceProviderName[] searchCriteriaServiceProviderName

searchCriteriaResellerId

@Valid
protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

Constructor Details

ServiceProviderGetListRequest

public ServiceProviderGetListRequest()

ServiceProviderGetListRequest

public ServiceProviderGetListRequest(BroadWorksServer broadWorksServer)

Method Details

setIsEnterprise

public ServiceProvider.ServiceProviderGetListRequest setIsEnterprise(Boolean isEnterprise)

getIsEnterprise

public Boolean getIsEnterprise()

setResponseSizeLimit

public ServiceProvider.ServiceProviderGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaServiceProviderId

public ServiceProvider.ServiceProviderGetListRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaServiceProviderName

public ServiceProvider.ServiceProviderGetListRequest setSearchCriteriaServiceProviderName(SearchCriteriaServiceProviderName... searchCriteriaServiceProviderName)

getSearchCriteriaServiceProviderName

public SearchCriteriaServiceProviderName[] getSearchCriteriaServiceProviderName()

setSearchCriteriaResellerId

public ServiceProvider.ServiceProviderGetListRequest setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)

getSearchCriteriaResellerId

public SearchCriteriaResellerId[] getSearchCriteriaResellerId()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<ServiceProvider.ServiceProviderGetListResponse>