Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCPEConfigModifyFileServerRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCPEConfigModifyFileServerRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCPEConfigModifyFileServerRequest
extends Request<DefaultResponse>

Modify a device CPE config file server. The response is either SuccessResponse or 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 Optional<@Size(min=1,max=256) String>	cpeFileDirectory
protected @NotNull @Size(min=1,max=40) String	deviceType
protected Optional<@Size(min=1,max=40) String>	extendedCaptureFileRepositoryName
protected @Size(min=1,max=40) String	fileRepositoryName

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCPEConfigModifyFileServerRequest()
SystemCPEConfigModifyFileServerRequest(BroadWorksServer broadWorksServer, String deviceType)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Size(min=1,max=256) String>	getCpeFileDirectory()
String	getDeviceType()
static BWSystem.SystemCPEConfigModifyFileServerRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<@Size(min=1,max=40) String>	getExtendedCaptureFileRepositoryName()
String	getFileRepositoryName()
BWSystem.SystemCPEConfigModifyFileServerRequest	setCpeFileDirectory(String cpeFileDirectory)
BWSystem.SystemCPEConfigModifyFileServerRequest	setDeviceType(String deviceType)
BWSystem.SystemCPEConfigModifyFileServerRequest	setExtendedCaptureFileRepositoryName(String extendedCaptureFileRepositoryName)
BWSystem.SystemCPEConfigModifyFileServerRequest	setFileRepositoryName(String fileRepositoryName)
BWSystem.SystemCPEConfigModifyFileServerRequest	unsetCpeFileDirectory()
BWSystem.SystemCPEConfigModifyFileServerRequest	unsetExtendedCaptureFileRepositoryName()

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

fileRepositoryName

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

cpeFileDirectory

protected Optional<@Size(min=1,max=256) String> cpeFileDirectory

extendedCaptureFileRepositoryName

protected Optional<@Size(min=1,max=40) String> extendedCaptureFileRepositoryName

Constructor Details

SystemCPEConfigModifyFileServerRequest

public SystemCPEConfigModifyFileServerRequest()

SystemCPEConfigModifyFileServerRequest

public SystemCPEConfigModifyFileServerRequest(BroadWorksServer broadWorksServer,
 String deviceType)

Method Details

setDeviceType

public BWSystem.SystemCPEConfigModifyFileServerRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setFileRepositoryName

public BWSystem.SystemCPEConfigModifyFileServerRequest setFileRepositoryName(String fileRepositoryName)

getFileRepositoryName

public String getFileRepositoryName()

unsetCpeFileDirectory

public BWSystem.SystemCPEConfigModifyFileServerRequest unsetCpeFileDirectory()

setCpeFileDirectory

public BWSystem.SystemCPEConfigModifyFileServerRequest setCpeFileDirectory(String cpeFileDirectory)

getCpeFileDirectory

public Optional<@Size(min=1,max=256) String> getCpeFileDirectory()

unsetExtendedCaptureFileRepositoryName

public BWSystem.SystemCPEConfigModifyFileServerRequest unsetExtendedCaptureFileRepositoryName()

setExtendedCaptureFileRepositoryName

public BWSystem.SystemCPEConfigModifyFileServerRequest setExtendedCaptureFileRepositoryName(String extendedCaptureFileRepositoryName)

getExtendedCaptureFileRepositoryName

public Optional<@Size(min=1,max=40) String> getExtendedCaptureFileRepositoryName()

getEmptyObject

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