Package co.ecg.alpaca.toolkit.generated

Class ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest

Enclosing class:

ServiceProvider

public static class ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest
extends Request<DefaultResponse>

Request to set a new service provider 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 ServiceProvider	serviceProvider

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

log

Constructor Summary

Constructors

Constructor	Description
ServiceProviderCPEConfigSetConfigFileRequest()
ServiceProviderCPEConfigSetConfigFileRequest(ServiceProvider serviceProvider, 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 ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
ServiceProvider	getServiceProvider()
ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest	setConfigFile(FileResource configFile)
ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest	setDeviceType(String deviceType)
ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest	setServiceProvider(ServiceProvider serviceProvider)
ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest	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 Detail

serviceProvider

@NotNull
@Valid
protected transient @NotNull @Valid ServiceProvider serviceProvider

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 Detail

ServiceProviderCPEConfigSetConfigFileRequest

public ServiceProviderCPEConfigSetConfigFileRequest()

ServiceProviderCPEConfigSetConfigFileRequest

public ServiceProviderCPEConfigSetConfigFileRequest(ServiceProvider serviceProvider,
                                                    String deviceType,
                                                    FileResource configFile)

Method Detail

setServiceProvider

public ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest setServiceProvider(ServiceProvider serviceProvider)

getServiceProvider

public ServiceProvider getServiceProvider()

setDeviceType

public ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

unsetConfigFile

public ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest unsetConfigFile()

setConfigFile

public ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest setConfigFile(FileResource configFile)

getConfigFile

public Optional<@Valid FileResource> getConfigFile()

getEmptyObject

public static ServiceProvider.ServiceProviderCPEConfigSetConfigFileRequest 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>