Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDeviceFamilyExportRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<BWSystem.SystemDeviceFamilyExportResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDeviceFamilyExportRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemDeviceFamilyExportRequest
extends Request<BWSystem.SystemDeviceFamilyExportResponse>

Request to export a device family. The response is either a SystemDeviceFamilyExportResponse or an 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 @NotNull @Size(min=1,max=30) String	deviceFamilyName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDeviceFamilyExportRequest()
SystemDeviceFamilyExportRequest(BroadWorksServer broadWorksServer, String deviceFamilyName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDeviceFamilyName()
static BWSystem.SystemDeviceFamilyExportRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
BWSystem.SystemDeviceFamilyExportRequest	setDeviceFamilyName(String deviceFamilyName)

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

deviceFamilyName

@NotNull
@Size(min=1,
      max=30)
protected @NotNull @Size(min=1,max=30) String deviceFamilyName

Constructor Details

SystemDeviceFamilyExportRequest

public SystemDeviceFamilyExportRequest()

SystemDeviceFamilyExportRequest

public SystemDeviceFamilyExportRequest(BroadWorksServer broadWorksServer,
 String deviceFamilyName)

Method Details

setDeviceFamilyName

public BWSystem.SystemDeviceFamilyExportRequest setDeviceFamilyName(String deviceFamilyName)

getDeviceFamilyName

public String getDeviceFamilyName()

getEmptyObject

public static BWSystem.SystemDeviceFamilyExportRequest getEmptyObject(BroadWorksServer broadWorksServer)

Retrieves this object with minimal setup.

Parameters:

broadWorksServer - The BroadWorksServer

formRequest

public void formRequest()

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

Overrides:

formRequest in class Request<BWSystem.SystemDeviceFamilyExportResponse>