Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemSIPDiversionReasonModifyRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemSIPDiversionReasonModifyRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemSIPDiversionReasonModifyRequest
extends Request<DefaultResponse>

Request to modify the SIP cause value for a given diversion reason. The response is either a 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(max=3) String	causeValue
protected @NotNull SIPDiversionReason	diversionReason

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

log

Constructor Summary

Constructors

Constructor	Description
SystemSIPDiversionReasonModifyRequest()
SystemSIPDiversionReasonModifyRequest(BroadWorksServer broadWorksServer, SIPDiversionReason diversionReason, String causeValue)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getCauseValue()
SIPDiversionReason	getDiversionReason()
static BWSystem.SystemSIPDiversionReasonModifyRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
BWSystem.SystemSIPDiversionReasonModifyRequest	setCauseValue(String causeValue)
BWSystem.SystemSIPDiversionReasonModifyRequest	setDiversionReason(SIPDiversionReason diversionReason)

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

diversionReason

@NotNull
protected @NotNull SIPDiversionReason diversionReason

causeValue

@NotNull
@Size(max=3)
protected @NotNull @Size(max=3) String causeValue

Constructor Details

SystemSIPDiversionReasonModifyRequest

public SystemSIPDiversionReasonModifyRequest()

SystemSIPDiversionReasonModifyRequest

public SystemSIPDiversionReasonModifyRequest(BroadWorksServer broadWorksServer,
 SIPDiversionReason diversionReason,
 String causeValue)

Method Details

setDiversionReason

public BWSystem.SystemSIPDiversionReasonModifyRequest setDiversionReason(SIPDiversionReason diversionReason)

getDiversionReason

public SIPDiversionReason getDiversionReason()

setCauseValue

public BWSystem.SystemSIPDiversionReasonModifyRequest setCauseValue(String causeValue)

getCauseValue

public String getCauseValue()

getEmptyObject

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