Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemConfigurableTreatmentModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemConfigurableTreatmentModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemConfigurableTreatmentModifyRequest
extends Request<DefaultResponse>

Modify the fields for a configurable treatment. 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 Boolean	accessSendReasonHeader
protected Optional<Integer>	accessSIPStatusCode
protected Optional<@Size(min=1,max=50) String>	accessSIPStatusMessage
protected Optional<@Size(min=1,max=256) String>	accessTreatmentAudioFile
protected Optional<@Size(min=1,max=256) String>	accessTreatmentVideoFile
protected Optional<@Size(min=1,max=3) String>	cdrTerminationCause
protected ChargeIndicator	chargeIndicator
protected Optional<@Size(min=1,max=80) String>	description
protected Optional<InternalReleaseCause16>	internalReleaseCause
protected Boolean	networkSendReasonHeader
protected Optional<Integer>	networkSIPStatusCode
protected Optional<@Size(min=1,max=50) String>	networkSIPStatusMessage
protected Optional<@Size(min=1,max=256) String>	networkTreatmentAudioFile
protected Optional<@Size(min=1,max=256) String>	networkTreatmentVideoFile
protected Optional<Integer>	q850CauseValue
protected Optional<@Size(min=1,max=50) String>	q850Text
protected Boolean	routeAdvance
protected @NotNull @Size(min=1,max=40) String	treatmentId

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

log

Constructor Summary

Constructors

Constructor	Description
SystemConfigurableTreatmentModifyRequest()
SystemConfigurableTreatmentModifyRequest(BroadWorksServer broadWorksServer, String treatmentId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Boolean	getAccessSendReasonHeader()
Optional<Integer>	getAccessSIPStatusCode()
Optional<@Size(min=1,max=50) String>	getAccessSIPStatusMessage()
Optional<@Size(min=1,max=256) String>	getAccessTreatmentAudioFile()
Optional<@Size(min=1,max=256) String>	getAccessTreatmentVideoFile()
Optional<@Size(min=1,max=3) String>	getCdrTerminationCause()
ChargeIndicator	getChargeIndicator()
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemConfigurableTreatmentModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Optional<InternalReleaseCause16>	getInternalReleaseCause()
Boolean	getNetworkSendReasonHeader()
Optional<Integer>	getNetworkSIPStatusCode()
Optional<@Size(min=1,max=50) String>	getNetworkSIPStatusMessage()
Optional<@Size(min=1,max=256) String>	getNetworkTreatmentAudioFile()
Optional<@Size(min=1,max=256) String>	getNetworkTreatmentVideoFile()
Optional<Integer>	getQ850CauseValue()
Optional<@Size(min=1,max=50) String>	getQ850Text()
Boolean	getRouteAdvance()
String	getTreatmentId()
BWSystem.SystemConfigurableTreatmentModifyRequest	setAccessSendReasonHeader(Boolean accessSendReasonHeader)
BWSystem.SystemConfigurableTreatmentModifyRequest	setAccessSIPStatusCode(Integer accessSIPStatusCode)
BWSystem.SystemConfigurableTreatmentModifyRequest	setAccessSIPStatusMessage(String accessSIPStatusMessage)
BWSystem.SystemConfigurableTreatmentModifyRequest	setAccessTreatmentAudioFile(String accessTreatmentAudioFile)
BWSystem.SystemConfigurableTreatmentModifyRequest	setAccessTreatmentVideoFile(String accessTreatmentVideoFile)
BWSystem.SystemConfigurableTreatmentModifyRequest	setCdrTerminationCause(String cdrTerminationCause)
BWSystem.SystemConfigurableTreatmentModifyRequest	setChargeIndicator(ChargeIndicator chargeIndicator)
BWSystem.SystemConfigurableTreatmentModifyRequest	setDescription(String description)
BWSystem.SystemConfigurableTreatmentModifyRequest	setInternalReleaseCause(InternalReleaseCause16 internalReleaseCause)
BWSystem.SystemConfigurableTreatmentModifyRequest	setNetworkSendReasonHeader(Boolean networkSendReasonHeader)
BWSystem.SystemConfigurableTreatmentModifyRequest	setNetworkSIPStatusCode(Integer networkSIPStatusCode)
BWSystem.SystemConfigurableTreatmentModifyRequest	setNetworkSIPStatusMessage(String networkSIPStatusMessage)
BWSystem.SystemConfigurableTreatmentModifyRequest	setNetworkTreatmentAudioFile(String networkTreatmentAudioFile)
BWSystem.SystemConfigurableTreatmentModifyRequest	setNetworkTreatmentVideoFile(String networkTreatmentVideoFile)
BWSystem.SystemConfigurableTreatmentModifyRequest	setQ850CauseValue(Integer q850CauseValue)
BWSystem.SystemConfigurableTreatmentModifyRequest	setQ850Text(String q850Text)
BWSystem.SystemConfigurableTreatmentModifyRequest	setRouteAdvance(Boolean routeAdvance)
BWSystem.SystemConfigurableTreatmentModifyRequest	setTreatmentId(String treatmentId)
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetAccessSIPStatusCode()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetAccessSIPStatusMessage()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetAccessTreatmentAudioFile()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetAccessTreatmentVideoFile()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetCdrTerminationCause()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetDescription()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetInternalReleaseCause()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetNetworkSIPStatusCode()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetNetworkSIPStatusMessage()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetNetworkTreatmentAudioFile()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetNetworkTreatmentVideoFile()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetQ850CauseValue()
BWSystem.SystemConfigurableTreatmentModifyRequest	unsetQ850Text()

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

treatmentId

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

chargeIndicator

protected ChargeIndicator chargeIndicator

description

protected Optional<@Size(min=1,max=80) String> description

accessSIPStatusCode

protected Optional<Integer> accessSIPStatusCode

accessSIPStatusMessage

protected Optional<@Size(min=1,max=50) String> accessSIPStatusMessage

networkSIPStatusCode

protected Optional<Integer> networkSIPStatusCode

networkSIPStatusMessage

protected Optional<@Size(min=1,max=50) String> networkSIPStatusMessage

q850CauseValue

protected Optional<Integer> q850CauseValue

q850Text

protected Optional<@Size(min=1,max=50) String> q850Text

accessTreatmentAudioFile

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

accessTreatmentVideoFile

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

networkTreatmentAudioFile

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

networkTreatmentVideoFile

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

cdrTerminationCause

protected Optional<@Size(min=1,max=3) String> cdrTerminationCause

routeAdvance

protected Boolean routeAdvance

internalReleaseCause

protected Optional<InternalReleaseCause16> internalReleaseCause

accessSendReasonHeader

protected Boolean accessSendReasonHeader

networkSendReasonHeader

protected Boolean networkSendReasonHeader

Constructor Details

SystemConfigurableTreatmentModifyRequest

public SystemConfigurableTreatmentModifyRequest()

SystemConfigurableTreatmentModifyRequest

public SystemConfigurableTreatmentModifyRequest(BroadWorksServer broadWorksServer,
 String treatmentId)

Method Details

setTreatmentId

public BWSystem.SystemConfigurableTreatmentModifyRequest setTreatmentId(String treatmentId)

getTreatmentId

public String getTreatmentId()

setChargeIndicator

public BWSystem.SystemConfigurableTreatmentModifyRequest setChargeIndicator(ChargeIndicator chargeIndicator)

getChargeIndicator

public ChargeIndicator getChargeIndicator()

unsetDescription

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetDescription()

setDescription

public BWSystem.SystemConfigurableTreatmentModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

unsetAccessSIPStatusCode

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetAccessSIPStatusCode()

setAccessSIPStatusCode

public BWSystem.SystemConfigurableTreatmentModifyRequest setAccessSIPStatusCode(Integer accessSIPStatusCode)

getAccessSIPStatusCode

public Optional<Integer> getAccessSIPStatusCode()

unsetAccessSIPStatusMessage

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetAccessSIPStatusMessage()

setAccessSIPStatusMessage

public BWSystem.SystemConfigurableTreatmentModifyRequest setAccessSIPStatusMessage(String accessSIPStatusMessage)

getAccessSIPStatusMessage

public Optional<@Size(min=1,max=50) String> getAccessSIPStatusMessage()

unsetNetworkSIPStatusCode

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetNetworkSIPStatusCode()

setNetworkSIPStatusCode

public BWSystem.SystemConfigurableTreatmentModifyRequest setNetworkSIPStatusCode(Integer networkSIPStatusCode)

getNetworkSIPStatusCode

public Optional<Integer> getNetworkSIPStatusCode()

unsetNetworkSIPStatusMessage

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetNetworkSIPStatusMessage()

setNetworkSIPStatusMessage

public BWSystem.SystemConfigurableTreatmentModifyRequest setNetworkSIPStatusMessage(String networkSIPStatusMessage)

getNetworkSIPStatusMessage

public Optional<@Size(min=1,max=50) String> getNetworkSIPStatusMessage()

unsetQ850CauseValue

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetQ850CauseValue()

setQ850CauseValue

public BWSystem.SystemConfigurableTreatmentModifyRequest setQ850CauseValue(Integer q850CauseValue)

getQ850CauseValue

public Optional<Integer> getQ850CauseValue()

unsetQ850Text

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetQ850Text()

setQ850Text

public BWSystem.SystemConfigurableTreatmentModifyRequest setQ850Text(String q850Text)

getQ850Text

public Optional<@Size(min=1,max=50) String> getQ850Text()

unsetAccessTreatmentAudioFile

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetAccessTreatmentAudioFile()

setAccessTreatmentAudioFile

public BWSystem.SystemConfigurableTreatmentModifyRequest setAccessTreatmentAudioFile(String accessTreatmentAudioFile)

getAccessTreatmentAudioFile

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

unsetAccessTreatmentVideoFile

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetAccessTreatmentVideoFile()

setAccessTreatmentVideoFile

public BWSystem.SystemConfigurableTreatmentModifyRequest setAccessTreatmentVideoFile(String accessTreatmentVideoFile)

getAccessTreatmentVideoFile

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

unsetNetworkTreatmentAudioFile

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetNetworkTreatmentAudioFile()

setNetworkTreatmentAudioFile

public BWSystem.SystemConfigurableTreatmentModifyRequest setNetworkTreatmentAudioFile(String networkTreatmentAudioFile)

getNetworkTreatmentAudioFile

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

unsetNetworkTreatmentVideoFile

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetNetworkTreatmentVideoFile()

setNetworkTreatmentVideoFile

public BWSystem.SystemConfigurableTreatmentModifyRequest setNetworkTreatmentVideoFile(String networkTreatmentVideoFile)

getNetworkTreatmentVideoFile

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

unsetCdrTerminationCause

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetCdrTerminationCause()

setCdrTerminationCause

public BWSystem.SystemConfigurableTreatmentModifyRequest setCdrTerminationCause(String cdrTerminationCause)

getCdrTerminationCause

public Optional<@Size(min=1,max=3) String> getCdrTerminationCause()

setRouteAdvance

public BWSystem.SystemConfigurableTreatmentModifyRequest setRouteAdvance(Boolean routeAdvance)

getRouteAdvance

public Boolean getRouteAdvance()

unsetInternalReleaseCause

public BWSystem.SystemConfigurableTreatmentModifyRequest unsetInternalReleaseCause()

setInternalReleaseCause

public BWSystem.SystemConfigurableTreatmentModifyRequest setInternalReleaseCause(InternalReleaseCause16 internalReleaseCause)

getInternalReleaseCause

public Optional<InternalReleaseCause16> getInternalReleaseCause()

setAccessSendReasonHeader

public BWSystem.SystemConfigurableTreatmentModifyRequest setAccessSendReasonHeader(Boolean accessSendReasonHeader)

getAccessSendReasonHeader

public Boolean getAccessSendReasonHeader()

setNetworkSendReasonHeader

public BWSystem.SystemConfigurableTreatmentModifyRequest setNetworkSendReasonHeader(Boolean networkSendReasonHeader)

getNetworkSendReasonHeader

public Boolean getNetworkSendReasonHeader()

getEmptyObject

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