Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceGetRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceGetRequest

Enclosing class:

SystemAccessDevice

@ChoiceGroup("systemAccessDevice") @ChoiceGroup("deviceExternalId")
public static class SystemAccessDevice.SystemAccessDeviceGetRequest
extends Request<SystemAccessDevice.SystemAccessDeviceGetResponse>

Requests the configuration of a specified system access device. The response is either SystemAccessDeviceGetResponse22V4 or ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: deviceExternalId

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 @Size(max=36) String	deviceExternalId
protected @Valid SystemAccessDevice	systemAccessDevice

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

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceGetRequest()
SystemAccessDeviceGetRequest(SystemAccessDevice systemAccessDevice)
SystemAccessDeviceGetRequest(BroadWorksServer broadWorksServer)
SystemAccessDeviceGetRequest(BroadWorksServer broadWorksServer, String deviceExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDeviceExternalId()
SystemAccessDevice	getSystemAccessDevice()
SystemAccessDevice.SystemAccessDeviceGetRequest	setDeviceExternalId(String deviceExternalId)
SystemAccessDevice.SystemAccessDeviceGetRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

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 Detail

systemAccessDevice

@Valid
protected transient @Valid SystemAccessDevice systemAccessDevice

deviceExternalId

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

Constructor Detail

SystemAccessDeviceGetRequest

public SystemAccessDeviceGetRequest()

SystemAccessDeviceGetRequest

public SystemAccessDeviceGetRequest(BroadWorksServer broadWorksServer)

SystemAccessDeviceGetRequest

public SystemAccessDeviceGetRequest(SystemAccessDevice systemAccessDevice)

SystemAccessDeviceGetRequest

public SystemAccessDeviceGetRequest(BroadWorksServer broadWorksServer,
                                    String deviceExternalId)

Method Detail

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceGetRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setDeviceExternalId

public SystemAccessDevice.SystemAccessDeviceGetRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<SystemAccessDevice.SystemAccessDeviceGetResponse>