Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest
extends Request<DefaultResponse>

Request to modify a system-level Dial Plan Access Code and its attribues. 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=5) String	accessCode
protected Optional<@Size(min=1,max=80) String>	description
protected Boolean	enableSecondaryDialTone
protected Boolean	includeCodeForNetworkTranslationsAndRouting
protected Boolean	includeCodeForScreeningServices

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

log

Constructor Summary

Constructors

Constructor	Description
SystemDialPlanPolicyModifyAccessCodeRequest()
SystemDialPlanPolicyModifyAccessCodeRequest(BroadWorksServer broadWorksServer, String accessCode)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getAccessCode()
Optional<@Size(min=1,max=80) String>	getDescription()
static BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableSecondaryDialTone()
Boolean	getIncludeCodeForNetworkTranslationsAndRouting()
Boolean	getIncludeCodeForScreeningServices()
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	setAccessCode(String accessCode)
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	setDescription(String description)
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	setEnableSecondaryDialTone(Boolean enableSecondaryDialTone)
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	setIncludeCodeForNetworkTranslationsAndRouting(Boolean includeCodeForNetworkTranslationsAndRouting)
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	setIncludeCodeForScreeningServices(Boolean includeCodeForScreeningServices)
BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest	unsetDescription()

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

accessCode

@NotNull
@Size(min=1,
      max=5)
protected @NotNull @Size(min=1,max=5) String accessCode

includeCodeForNetworkTranslationsAndRouting

protected Boolean includeCodeForNetworkTranslationsAndRouting

includeCodeForScreeningServices

protected Boolean includeCodeForScreeningServices

enableSecondaryDialTone

protected Boolean enableSecondaryDialTone

description

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

Constructor Detail

SystemDialPlanPolicyModifyAccessCodeRequest

public SystemDialPlanPolicyModifyAccessCodeRequest()

SystemDialPlanPolicyModifyAccessCodeRequest

public SystemDialPlanPolicyModifyAccessCodeRequest(BroadWorksServer broadWorksServer,
                                                   String accessCode)

Method Detail

setAccessCode

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest setAccessCode(String accessCode)

getAccessCode

public String getAccessCode()

setIncludeCodeForNetworkTranslationsAndRouting

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest setIncludeCodeForNetworkTranslationsAndRouting(Boolean includeCodeForNetworkTranslationsAndRouting)

getIncludeCodeForNetworkTranslationsAndRouting

public Boolean getIncludeCodeForNetworkTranslationsAndRouting()

setIncludeCodeForScreeningServices

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest setIncludeCodeForScreeningServices(Boolean includeCodeForScreeningServices)

getIncludeCodeForScreeningServices

public Boolean getIncludeCodeForScreeningServices()

setEnableSecondaryDialTone

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest setEnableSecondaryDialTone(Boolean enableSecondaryDialTone)

getEnableSecondaryDialTone

public Boolean getEnableSecondaryDialTone()

unsetDescription

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest unsetDescription()

setDescription

public BWSystem.SystemDialPlanPolicyModifyAccessCodeRequest setDescription(String description)

getDescription

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

getEmptyObject

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