Package co.ecg.alpaca.toolkit.generated

Class Group.GroupCPEConfigSetConfigFileRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.Group.GroupCPEConfigSetConfigFileRequest

Enclosing class:

Group

public static class Group.GroupCPEConfigSetConfigFileRequest
extends Request<DefaultResponse>

Request to set a new group default configuration file for a device type. The response is either a SuccessResponse or an ErrorResponse. When the element configFile is set to nil, the configuration file defined at the parent level is used.

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 Optional<@Valid FileResource>	configFile
protected @NotNull @Size(min=1,max=40) String	deviceType
protected @NotNull @Valid Group	group

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

log

Constructor Summary

Constructors

Constructor	Description
GroupCPEConfigSetConfigFileRequest()
GroupCPEConfigSetConfigFileRequest(Group group, String deviceType, FileResource configFile)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Valid FileResource>	getConfigFile()
String	getDeviceType()
static Group.GroupCPEConfigSetConfigFileRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Group	getGroup()
Group.GroupCPEConfigSetConfigFileRequest	setConfigFile(FileResource configFile)
Group.GroupCPEConfigSetConfigFileRequest	setDeviceType(String deviceType)
Group.GroupCPEConfigSetConfigFileRequest	setGroup(Group group)
Group.GroupCPEConfigSetConfigFileRequest	unsetConfigFile()

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

group

@NotNull
@Valid
protected transient @NotNull @Valid Group group

deviceType

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

configFile

@NotNull
protected @NotNull Optional<@Valid FileResource> configFile

Constructor Details

GroupCPEConfigSetConfigFileRequest

public GroupCPEConfigSetConfigFileRequest()

GroupCPEConfigSetConfigFileRequest

public GroupCPEConfigSetConfigFileRequest(Group group,
 String deviceType,
 FileResource configFile)

Method Details

setGroup

public Group.GroupCPEConfigSetConfigFileRequest setGroup(Group group)

getGroup

public Group getGroup()

setDeviceType

public Group.GroupCPEConfigSetConfigFileRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

unsetConfigFile

public Group.GroupCPEConfigSetConfigFileRequest unsetConfigFile()

setConfigFile

public Group.GroupCPEConfigSetConfigFileRequest setConfigFile(FileResource configFile)

getConfigFile

public Optional<@Valid FileResource> getConfigFile()

getEmptyObject

public static Group.GroupCPEConfigSetConfigFileRequest 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>