Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceGetListRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceGetListRequest

Enclosing class:

SystemAccessDevice

public static class SystemAccessDevice.SystemAccessDeviceGetListRequest
extends Request<SystemAccessDevice.SystemAccessDeviceGetListResponse>

Requests the list of access devices defined at the System-level. Prior to release 14, this command requested a list of all devices in the entire system. That functionality is now moved to the SystemAccessDeviceGetAllRequest. The response is either SystemAccessDeviceGetListResponse14 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

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceGetListRequest()
SystemAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)

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()
SystemAccessDevice.SystemAccessDeviceGetListRequest	setResponseSizeLimit(Integer responseSizeLimit)
SystemAccessDevice.SystemAccessDeviceGetListRequest	setSearchCriteriaAccessDeviceVersion(SearchCriteriaAccessDeviceVersion... searchCriteriaAccessDeviceVersion)
SystemAccessDevice.SystemAccessDeviceGetListRequest	setSearchCriteriaDeviceMACAddress(SearchCriteriaDeviceMACAddress... searchCriteriaDeviceMACAddress)
SystemAccessDevice.SystemAccessDeviceGetListRequest	setSearchCriteriaDeviceName(SearchCriteriaDeviceName... searchCriteriaDeviceName)
SystemAccessDevice.SystemAccessDeviceGetListRequest	setSearchCriteriaDeviceNetAddress(SearchCriteriaDeviceNetAddress... searchCriteriaDeviceNetAddress)
SystemAccessDevice.SystemAccessDeviceGetListRequest	setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

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

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

SystemAccessDeviceGetListRequest

public SystemAccessDeviceGetListRequest()

SystemAccessDeviceGetListRequest

public SystemAccessDeviceGetListRequest(BroadWorksServer broadWorksServer)

Method Details

setResponseSizeLimit

public SystemAccessDevice.SystemAccessDeviceGetListRequest setResponseSizeLimit(Integer responseSizeLimit)

getResponseSizeLimit

public Integer getResponseSizeLimit()

setSearchCriteriaDeviceName

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

getSearchCriteriaDeviceName

public SearchCriteriaDeviceName[] getSearchCriteriaDeviceName()

setSearchCriteriaDeviceMACAddress

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

getSearchCriteriaDeviceMACAddress

public SearchCriteriaDeviceMACAddress[] getSearchCriteriaDeviceMACAddress()

setSearchCriteriaDeviceNetAddress

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

getSearchCriteriaDeviceNetAddress

public SearchCriteriaDeviceNetAddress[] getSearchCriteriaDeviceNetAddress()

setSearchCriteriaExactDeviceType

public SystemAccessDevice.SystemAccessDeviceGetListRequest setSearchCriteriaExactDeviceType(SearchCriteriaExactDeviceType searchCriteriaExactDeviceType)

getSearchCriteriaExactDeviceType

public SearchCriteriaExactDeviceType getSearchCriteriaExactDeviceType()

setSearchCriteriaAccessDeviceVersion

public SystemAccessDevice.SystemAccessDeviceGetListRequest 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<SystemAccessDevice.SystemAccessDeviceGetListResponse>