Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest
extends Request<DefaultResponse>

Request to apply an extended file capture value to all the profile instances associated to a sip device type file. 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 @NotNull @Size(min=1,max=40) String	deviceType
protected @NotNull Boolean	extendedCaptureOnUploadFromDevice
protected @NotNull @Size(min=1,max=128) String	fileFormat

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest()
SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest(BroadWorksServer broadWorksServer, String deviceType, String fileFormat, Boolean extendedCaptureOnUploadFromDevice)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getDeviceType()
static BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getExtendedCaptureOnUploadFromDevice()
String	getFileFormat()
BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest	setDeviceType(String deviceType)
BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest	setExtendedCaptureOnUploadFromDevice(Boolean extendedCaptureOnUploadFromDevice)
BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest	setFileFormat(String fileFormat)

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, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, 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

deviceType

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

fileFormat

@NotNull
@Size(min=1,
      max=128)
protected @NotNull @Size(min=1,max=128) String fileFormat

extendedCaptureOnUploadFromDevice

@NotNull
protected @NotNull Boolean extendedCaptureOnUploadFromDevice

Constructor Detail

SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest

public SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest()

SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest

public SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest(BroadWorksServer broadWorksServer,
                                                                         String deviceType,
                                                                         String fileFormat,
                                                                         Boolean extendedCaptureOnUploadFromDevice)

Method Detail

setDeviceType

public BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest setDeviceType(String deviceType)

getDeviceType

public String getDeviceType()

setFileFormat

public BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest setFileFormat(String fileFormat)

getFileFormat

public String getFileFormat()

setExtendedCaptureOnUploadFromDevice

public BWSystem.SystemSIPDeviceFileApplyExtendedCaptureToAllDeviceProfilesRequest setExtendedCaptureOnUploadFromDevice(Boolean extendedCaptureOnUploadFromDevice)

getExtendedCaptureOnUploadFromDevice

public Boolean getExtendedCaptureOnUploadFromDevice()

getEmptyObject

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