Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceGetAllRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<SystemAccessDevice.SystemAccessDeviceGetAllResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceGetAllRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceGetAllRequest
extends Request<SystemAccessDevice.SystemAccessDeviceGetAllResponse>

Requests the list of all access devices in the entire system. Prior to release 14, this functionality was provided with the SystemAccessDeviceGetListRequest14. If reseller administrator sends the request, searchCriteriaResellerId is ignored. All the device profiles in the administrator's reseller meeting the search criteria are returned. The response is either SystemAccessDeviceGetAllResponse or 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 Integer	responseSizeLimit
protected @Valid SearchCriteriaDeviceMACAddress[]	searchCriteriaDeviceMACAddress
protected @Valid SearchCriteriaDeviceName[]	searchCriteriaDeviceName
protected @Valid SearchCriteriaDeviceNetAddress[]	searchCriteriaDeviceNetAddress
protected @Valid SearchCriteriaExactDeviceServiceProvider	searchCriteriaExactDeviceServiceProvider
protected @Valid SearchCriteriaExactDeviceType	searchCriteriaExactDeviceType
protected @Valid SearchCriteriaGroupId[]	searchCriteriaGroupId
protected @Valid SearchCriteriaResellerId[]	searchCriteriaResellerId
protected @Valid SearchCriteriaServiceProviderId[]	searchCriteriaServiceProviderId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceGetAllRequest()
SystemAccessDeviceGetAllRequest(BroadWorksServer broadWorksServer)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Integer	getResponseSizeLimit()
SearchCriteriaDeviceMACAddress[]	getSearchCriteriaDeviceMACAddress()
SearchCriteriaDeviceName[]	getSearchCriteriaDeviceName()
SearchCriteriaDeviceNetAddress[]	getSearchCriteriaDeviceNetAddress()
SearchCriteriaExactDeviceServiceProvider	getSearchCriteriaExactDeviceServiceProvider()
SearchCriteriaExactDeviceType	getSearchCriteriaExactDeviceType()
SearchCriteriaGroupId[]	getSearchCriteriaGroupId()
SearchCriteriaResellerId[]	getSearchCriteriaResellerId()
SearchCriteriaServiceProviderId[]	getSearchCriteriaServiceProviderId()
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setResponseSizeLimit(Integer responseSizeLimit)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaExactDeviceServiceProvider(SearchCriteriaExactDeviceServiceProvider searchCriteriaExactDeviceServiceProvider)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	setSearchCriteriaResellerId(SearchCriteriaResellerId... searchCriteriaResellerId)
SystemAccessDevice.SystemAccessDeviceGetAllRequest	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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

responseSizeLimit

protected Integer responseSizeLimit

searchCriteriaDeviceName

@Valid
protected @Valid SearchCriteriaDeviceName[] searchCriteriaDeviceName

searchCriteriaDeviceMACAddress

@Valid
protected @Valid SearchCriteriaDeviceMACAddress[] searchCriteriaDeviceMACAddress

searchCriteriaDeviceNetAddress

@Valid
protected @Valid SearchCriteriaDeviceNetAddress[] searchCriteriaDeviceNetAddress

searchCriteriaGroupId

@Valid
protected @Valid SearchCriteriaGroupId[] searchCriteriaGroupId

searchCriteriaExactDeviceType

@Valid
protected @Valid SearchCriteriaExactDeviceType searchCriteriaExactDeviceType

searchCriteriaExactDeviceServiceProvider

@Valid
protected @Valid SearchCriteriaExactDeviceServiceProvider searchCriteriaExactDeviceServiceProvider

searchCriteriaServiceProviderId

@Valid
protected @Valid SearchCriteriaServiceProviderId[] searchCriteriaServiceProviderId

searchCriteriaResellerId

@Valid
protected @Valid SearchCriteriaResellerId[] searchCriteriaResellerId

Constructor Detail

SystemAccessDeviceGetAllRequest

public SystemAccessDeviceGetAllRequest()

SystemAccessDeviceGetAllRequest

public SystemAccessDeviceGetAllRequest(BroadWorksServer broadWorksServer)

Method Detail

setResponseSizeLimit

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaDeviceName

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)

getSearchCriteriaDeviceName

public SearchCriteriaDeviceName[] getSearchCriteriaDeviceName()

setSearchCriteriaDeviceMACAddress

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)

getSearchCriteriaDeviceMACAddress

public SearchCriteriaDeviceMACAddress[] getSearchCriteriaDeviceMACAddress()

setSearchCriteriaDeviceNetAddress

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)

getSearchCriteriaDeviceNetAddress

public SearchCriteriaDeviceNetAddress[] getSearchCriteriaDeviceNetAddress()

setSearchCriteriaGroupId

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaGroupId(SearchCriteriaGroupId... searchCriteriaGroupId)

getSearchCriteriaGroupId

public SearchCriteriaGroupId[] getSearchCriteriaGroupId()

setSearchCriteriaExactDeviceType

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

getSearchCriteriaExactDeviceType

public SearchCriteriaExactDeviceType getSearchCriteriaExactDeviceType()

setSearchCriteriaExactDeviceServiceProvider

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaExactDeviceServiceProvider(SearchCriteriaExactDeviceServiceProvider searchCriteriaExactDeviceServiceProvider)

getSearchCriteriaExactDeviceServiceProvider

public SearchCriteriaExactDeviceServiceProvider getSearchCriteriaExactDeviceServiceProvider()

setSearchCriteriaServiceProviderId

public SystemAccessDevice.SystemAccessDeviceGetAllRequest setSearchCriteriaServiceProviderId(SearchCriteriaServiceProviderId... searchCriteriaServiceProviderId)

getSearchCriteriaServiceProviderId

public SearchCriteriaServiceProviderId[] getSearchCriteriaServiceProviderId()

setSearchCriteriaResellerId

public SystemAccessDevice.SystemAccessDeviceGetAllRequest 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<SystemAccessDevice.SystemAccessDeviceGetAllResponse>