Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCPEConfigSetConfigFileRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCPEConfigSetConfigFileRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCPEConfigSetConfigFileRequest
extends Request<DefaultResponse>

Request to set a new system default configuration file for a device type. The response is either a SuccessResponse 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=256) String	configFile
protected @NotNull @Size(min=1,max=40) String	deviceType

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCPEConfigSetConfigFileRequest()
SystemCPEConfigSetConfigFileRequest(BroadWorksServer broadWorksServer, String deviceType, String configFile)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getConfigFile()
String	getDeviceType()
static BWSystem.SystemCPEConfigSetConfigFileRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
BWSystem.SystemCPEConfigSetConfigFileRequest	setConfigFile(String configFile)
BWSystem.SystemCPEConfigSetConfigFileRequest	setDeviceType(String deviceType)

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

deviceType

@NotNull
@Size(min=1,
      max=40)
protected @NotNull @Size(min=1,max=40) String deviceType

configFile

@NotNull
@Size(min=1,
      max=256)
protected @NotNull @Size(min=1,max=256) String configFile

Constructor Details

SystemCPEConfigSetConfigFileRequest

public SystemCPEConfigSetConfigFileRequest()

SystemCPEConfigSetConfigFileRequest

public SystemCPEConfigSetConfigFileRequest(BroadWorksServer broadWorksServer,
 String deviceType,
 String configFile)

Method Details

setDeviceType

public BWSystem.SystemCPEConfigSetConfigFileRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setConfigFile

public BWSystem.SystemCPEConfigSetConfigFileRequest setConfigFile(String configFile)

getConfigFile

public String getConfigFile()

getEmptyObject

public static BWSystem.SystemCPEConfigSetConfigFileRequest 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<DefaultResponse>