Package co.ecg.alpaca.toolkit.generated

Class BWSystem.SystemCountryCodeAddRequest

java.lang.Object

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

co.ecg.alpaca.toolkit.generated.BWSystem.SystemCountryCodeAddRequest

Enclosing class:

BWSystem

public static class BWSystem.SystemCountryCodeAddRequest
extends Request<DefaultResponse>

Add a country code to the system. If ringPeriodMilliseconds is not specified, a default of 6000 milliseconds is assumed. If offHookWarningTimerSeconds is not specified, a default of 30 seconds is assumed. If enableNationalPrefix is not specified, a default of false is assumed. If nationalPrefix is not specified, a default of null string is assumed. If disableNationalPrefixForOffNetCalls is not specified, a default of false is assumed. The following elements are only used in AS data mode: disableNationalPrefixForOffNetCalls. 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 @NotNull @Size(max=3) String	countryCode
protected @NotNull @Size(min=1,max=80) String	countryName
protected Boolean	disableNationalPrefixForOffNetCalls
protected Boolean	enableNationalPrefix
protected Integer	maxCallWaitingTones
protected @Size(min=1,max=2) String	nationalPrefix
protected Integer	offHookWarningTimerSeconds
protected Integer	ringPeriodMilliseconds
protected Integer	timeBetweenCallWaitingTonesMilliseconds

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

log

Constructor Summary

Constructors

Constructor	Description
SystemCountryCodeAddRequest()
SystemCountryCodeAddRequest(BroadWorksServer broadWorksServer, String countryCode, String countryName)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
String	getCountryCode()
String	getCountryName()
Boolean	getDisableNationalPrefixForOffNetCalls()
static BWSystem.SystemCountryCodeAddRequest	getEmptyObject(BroadWorksServer broadWorksServer)	Retrieves this object with minimal setup.
Boolean	getEnableNationalPrefix()
Integer	getMaxCallWaitingTones()
String	getNationalPrefix()
Integer	getOffHookWarningTimerSeconds()
Integer	getRingPeriodMilliseconds()
Integer	getTimeBetweenCallWaitingTonesMilliseconds()
BWSystem.SystemCountryCodeAddRequest	setCountryCode(String countryCode)
BWSystem.SystemCountryCodeAddRequest	setCountryName(String countryName)
BWSystem.SystemCountryCodeAddRequest	setDisableNationalPrefixForOffNetCalls(Boolean disableNationalPrefixForOffNetCalls)
BWSystem.SystemCountryCodeAddRequest	setEnableNationalPrefix(Boolean enableNationalPrefix)
BWSystem.SystemCountryCodeAddRequest	setMaxCallWaitingTones(Integer maxCallWaitingTones)
BWSystem.SystemCountryCodeAddRequest	setNationalPrefix(String nationalPrefix)
BWSystem.SystemCountryCodeAddRequest	setOffHookWarningTimerSeconds(Integer offHookWarningTimerSeconds)
BWSystem.SystemCountryCodeAddRequest	setRingPeriodMilliseconds(Integer ringPeriodMilliseconds)
BWSystem.SystemCountryCodeAddRequest	setTimeBetweenCallWaitingTonesMilliseconds(Integer timeBetweenCallWaitingTonesMilliseconds)

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

countryCode

@NotNull
@Pattern(regexp="[0-9]|[1-9][0-9]{1,2}")
@Size(max=3)
protected @NotNull @Size(max=3) String countryCode

countryName

@NotNull
@Size(min=1,
      max=80)
protected @NotNull @Size(min=1,max=80) String countryName

ringPeriodMilliseconds

protected Integer ringPeriodMilliseconds

offHookWarningTimerSeconds

protected Integer offHookWarningTimerSeconds

enableNationalPrefix

protected Boolean enableNationalPrefix

nationalPrefix

@Size(min=1,
      max=2)
protected @Size(min=1,max=2) String nationalPrefix

maxCallWaitingTones

protected Integer maxCallWaitingTones

timeBetweenCallWaitingTonesMilliseconds

protected Integer timeBetweenCallWaitingTonesMilliseconds

disableNationalPrefixForOffNetCalls

protected Boolean disableNationalPrefixForOffNetCalls

Constructor Detail

SystemCountryCodeAddRequest

public SystemCountryCodeAddRequest()

SystemCountryCodeAddRequest

public SystemCountryCodeAddRequest(BroadWorksServer broadWorksServer,
                                   String countryCode,
                                   String countryName)

Method Detail

setCountryCode

public BWSystem.SystemCountryCodeAddRequest setCountryCode(String countryCode)

getCountryCode

public String getCountryCode()

setCountryName

public BWSystem.SystemCountryCodeAddRequest setCountryName(String countryName)

getCountryName

public String getCountryName()

setRingPeriodMilliseconds

public BWSystem.SystemCountryCodeAddRequest setRingPeriodMilliseconds(Integer ringPeriodMilliseconds)

getRingPeriodMilliseconds

public Integer getRingPeriodMilliseconds()

setOffHookWarningTimerSeconds

public BWSystem.SystemCountryCodeAddRequest setOffHookWarningTimerSeconds(Integer offHookWarningTimerSeconds)

getOffHookWarningTimerSeconds

public Integer getOffHookWarningTimerSeconds()

setEnableNationalPrefix

public BWSystem.SystemCountryCodeAddRequest setEnableNationalPrefix(Boolean enableNationalPrefix)

getEnableNationalPrefix

public Boolean getEnableNationalPrefix()

setNationalPrefix

public BWSystem.SystemCountryCodeAddRequest setNationalPrefix(String nationalPrefix)

getNationalPrefix

public String getNationalPrefix()

setMaxCallWaitingTones

public BWSystem.SystemCountryCodeAddRequest setMaxCallWaitingTones(Integer maxCallWaitingTones)

getMaxCallWaitingTones

public Integer getMaxCallWaitingTones()

setTimeBetweenCallWaitingTonesMilliseconds

public BWSystem.SystemCountryCodeAddRequest setTimeBetweenCallWaitingTonesMilliseconds(Integer timeBetweenCallWaitingTonesMilliseconds)

getTimeBetweenCallWaitingTonesMilliseconds

public Integer getTimeBetweenCallWaitingTonesMilliseconds()

setDisableNationalPrefixForOffNetCalls

public BWSystem.SystemCountryCodeAddRequest setDisableNationalPrefixForOffNetCalls(Boolean disableNationalPrefixForOffNetCalls)

getDisableNationalPrefixForOffNetCalls

public Boolean getDisableNationalPrefixForOffNetCalls()

getEmptyObject

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