Package co.ecg.alpaca.toolkit.generated

Class ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListResponse>

co.ecg.alpaca.toolkit.generated.ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest

Enclosing class:

ServiceProviderAccessDevice

@ChoiceGroup("serviceProvider") @ChoiceGroup("serviceProviderExternalId")
public static class ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest
extends Request<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListResponse>

Requests the list of access devices in a service provider. The following elements are only used in AS data mode and ignored in XS data mode: serviceProviderExternalId The response is either ServiceProviderAccessDeviceGetListResponse or 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaAccessDeviceVersion[]	searchCriteriaAccessDeviceVersion
protected @Valid SearchCriteriaDeviceMACAddress[]	searchCriteriaDeviceMACAddress
protected @Valid SearchCriteriaDeviceName[]	searchCriteriaDeviceName
protected @Valid SearchCriteriaDeviceNetAddress[]	searchCriteriaDeviceNetAddress
protected @Valid SearchCriteriaExactDeviceType	searchCriteriaExactDeviceType
protected @Valid ServiceProvider	serviceProvider
protected @Size(max=36) String	serviceProviderExternalId

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderAccessDeviceGetListRequest()
ServiceProviderAccessDeviceGetListRequest(ServiceProvider serviceProvider)
ServiceProviderAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)
ServiceProviderAccessDeviceGetListRequest(BroadWorksServer broadWorksServer, String serviceProviderExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaAccessDeviceVersion[]	getSearchCriteriaAccessDeviceVersion()
SearchCriteriaDeviceMACAddress[]	getSearchCriteriaDeviceMACAddress()
SearchCriteriaDeviceName[]	getSearchCriteriaDeviceName()
SearchCriteriaDeviceNetAddress[]	getSearchCriteriaDeviceNetAddress()
SearchCriteriaExactDeviceType	getSearchCriteriaExactDeviceType()
ServiceProvider	getServiceProvider()
String	getServiceProviderExternalId()
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setSearchCriteriaAccessDeviceVersion(SearchCriteriaAccessDeviceVersion... searchCriteriaAccessDeviceVersion)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setServiceProvider(ServiceProvider serviceProvider)
ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest	setServiceProviderExternalId(String serviceProviderExternalId)

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

@Valid
protected transient @Valid ServiceProvider serviceProvider

serviceProviderExternalId

@Size(max=36)
protected @Size(max=36) String serviceProviderExternalId

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaDeviceName

@Valid
protected @Valid SearchCriteriaDeviceName[] searchCriteriaDeviceName

searchCriteriaDeviceMACAddress

@Valid
protected @Valid SearchCriteriaDeviceMACAddress[] searchCriteriaDeviceMACAddress

searchCriteriaDeviceNetAddress

@Valid
protected @Valid SearchCriteriaDeviceNetAddress[] searchCriteriaDeviceNetAddress

searchCriteriaExactDeviceType

@Valid
protected @Valid SearchCriteriaExactDeviceType searchCriteriaExactDeviceType

searchCriteriaAccessDeviceVersion

@Valid
protected @Valid SearchCriteriaAccessDeviceVersion[] searchCriteriaAccessDeviceVersion

Constructor Details

ServiceProviderAccessDeviceGetListRequest

public ServiceProviderAccessDeviceGetListRequest()

ServiceProviderAccessDeviceGetListRequest

public ServiceProviderAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)

ServiceProviderAccessDeviceGetListRequest

public ServiceProviderAccessDeviceGetListRequest(ServiceProvider serviceProvider)

ServiceProviderAccessDeviceGetListRequest

public ServiceProviderAccessDeviceGetListRequest(BroadWorksServer broadWorksServer,
 String serviceProviderExternalId)

Method Details

setServiceProvider

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setServiceProviderExternalId

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setServiceProviderExternalId(String serviceProviderExternalId)

getServiceProviderExternalId

public String getServiceProviderExternalId()

setResponseSizeLimit

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaDeviceName

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)

getSearchCriteriaDeviceName

public SearchCriteriaDeviceName[] getSearchCriteriaDeviceName()

setSearchCriteriaDeviceMACAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)

getSearchCriteriaDeviceMACAddress

public SearchCriteriaDeviceMACAddress[] getSearchCriteriaDeviceMACAddress()

setSearchCriteriaDeviceNetAddress

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)

getSearchCriteriaDeviceNetAddress

public SearchCriteriaDeviceNetAddress[] getSearchCriteriaDeviceNetAddress()

setSearchCriteriaExactDeviceType

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

getSearchCriteriaExactDeviceType

public SearchCriteriaExactDeviceType getSearchCriteriaExactDeviceType()

setSearchCriteriaAccessDeviceVersion

public ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListRequest setSearchCriteriaAccessDeviceVersion(SearchCriteriaAccessDeviceVersion... searchCriteriaAccessDeviceVersion)

getSearchCriteriaAccessDeviceVersion

public SearchCriteriaAccessDeviceVersion[] getSearchCriteriaAccessDeviceVersion()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<ServiceProviderAccessDevice.ServiceProviderAccessDeviceGetListResponse>