com.opencloud.slee.resources.cgin.callcontrol

Class CCCollectedDigits

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCCollectedDigits

All Implemented Interfaces:

DataObject, Serializable

public class CCCollectedDigits
extends AbstractFieldsObject

API for CC-DataTypes.CollectedDigits. Generated from the following ASN.1 type definition and the adaptations below.

 CollectedDigits ::=
     SEQUENCE {
         minimumNbOfDigits   INTEGER (1..127) DEFAULT 1,
         maximumNbOfDigits   INTEGER (1..127),
         endOfReplyDigit     OCTET STRING (SIZE (1..2)) OPTIONAL,
         cancelDigit         OCTET STRING (SIZE (1..2)) OPTIONAL,
         startDigit          OCTET STRING (SIZE (1..2)) OPTIONAL,
         firstDigitTimeOut   INTEGER (1..127) OPTIONAL,
         interDigitTimeOut   INTEGER (1..127) OPTIONAL,
         errortreatment      ErrorTreatment DEFAULT stdErrorAndInfo,
         interruptableAnnInd BOOLEAN DEFAULT TRUE,
         voiceInformation    BOOLEAN DEFAULT FALSE,
         voiceBack           BOOLEAN DEFAULT FALSE
     }
 CC-DataTypes {
     CollectedDigits {
         cancelDigit {
             @import com.opencloud.slee.resources.in.datatypes.cc.AddressDelimiter
         }
         endOfReplyDigit {
             @import com.opencloud.slee.resources.in.datatypes.cc.AddressDelimiter
         }
         startDigit {
             @import com.opencloud.slee.resources.in.datatypes.cc.AddressDelimiter
         }
     }
 }
 

Used as field type by CCCollectedInfo.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

Constructor and Description
CCCollectedDigits() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CCCollectedDigits	clone() Constructs a copy of this object and everything reachable from it.
static CCCollectedDigits	copyOf(CCCollectedDigits from) Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.
AddressDelimiter	getCancelDigit() Gets the value of the field cancelDigit.
AddressDelimiter	getEndOfReplyDigit() Gets the value of the field endOfReplyDigit.
CCErrorTreatment	getErrortreatment() Gets the value of the field errortreatment.
static FieldAccessor[]	getFieldAccessors() Gets a new array of the accessors for fields of this type.
Map<String,Object>	getFieldsMap(boolean withAbsents) Gets a Map from field-name to field-value.
int	getFirstDigitTimeOut() Gets the value of the field firstDigitTimeOut.
int	getInterDigitTimeOut() Gets the value of the field interDigitTimeOut.
boolean	getInterruptableAnnInd() Gets the value of the field interruptableAnnInd.
int	getMaximumNbOfDigits() Gets the value of the field maximumNbOfDigits.
int	getMinimumNbOfDigits() Gets the value of the field minimumNbOfDigits.
AddressDelimiter	getStartDigit() Gets the value of the field startDigit.
boolean	getVoiceBack() Gets the value of the field voiceBack.
boolean	getVoiceInformation() Gets the value of the field voiceInformation.
boolean	hasCancelDigit() Tests whether the field cancelDigit has a value.
boolean	hasEndOfReplyDigit() Tests whether the field endOfReplyDigit has a value.
boolean	hasErrortreatment() Tests whether the field errortreatment has a value.
boolean	hasFirstDigitTimeOut() Tests whether the field firstDigitTimeOut has a value.
boolean	hasInterDigitTimeOut() Tests whether the field interDigitTimeOut has a value.
boolean	hasInterruptableAnnInd() Tests whether the field interruptableAnnInd has a value.
boolean	hasMaximumNbOfDigits() Tests whether the field maximumNbOfDigits has a value.
boolean	hasMinimumNbOfDigits() Tests whether the field minimumNbOfDigits has a value.
boolean	hasStartDigit() Tests whether the field startDigit has a value.
boolean	hasVoiceBack() Tests whether the field voiceBack has a value.
boolean	hasVoiceInformation() Tests whether the field voiceInformation has a value.
CCCollectedDigits	setCancelDigit(AddressDelimiter value) Sets the value of the field cancelDigit.
CCCollectedDigits	setEndOfReplyDigit(AddressDelimiter value) Sets the value of the field endOfReplyDigit.
CCCollectedDigits	setErrortreatment(CCErrorTreatment value) Sets the value of the field errortreatment.
CCCollectedDigits	setFirstDigitTimeOut(int value) Sets the value of the field firstDigitTimeOut and marks the field as present.
CCCollectedDigits	setFirstDigitTimeOutPresent(boolean flag) Sets the presence or absence of the optional field firstDigitTimeOut.
CCCollectedDigits	setInterDigitTimeOut(int value) Sets the value of the field interDigitTimeOut and marks the field as present.
CCCollectedDigits	setInterDigitTimeOutPresent(boolean flag) Sets the presence or absence of the optional field interDigitTimeOut.
CCCollectedDigits	setInterruptableAnnInd(boolean value) Sets the value of the field interruptableAnnInd and marks the field as present.
CCCollectedDigits	setInterruptableAnnIndPresent(boolean flag) Sets the presence or absence of the optional field interruptableAnnInd.
CCCollectedDigits	setMaximumNbOfDigits(int value) Sets the value of the field maximumNbOfDigits and marks the field as present.
CCCollectedDigits	setMinimumNbOfDigits(int value) Sets the value of the field minimumNbOfDigits and marks the field as present.
CCCollectedDigits	setMinimumNbOfDigitsPresent(boolean flag) Sets the presence or absence of the optional field minimumNbOfDigits.
void	setReadOnly() Sets this and all its fields to be immutable.
CCCollectedDigits	setStartDigit(AddressDelimiter value) Sets the value of the field startDigit.
CCCollectedDigits	setVoiceBack(boolean value) Sets the value of the field voiceBack and marks the field as present.
CCCollectedDigits	setVoiceBackPresent(boolean flag) Sets the presence or absence of the optional field voiceBack.
CCCollectedDigits	setVoiceInformation(boolean value) Sets the value of the field voiceInformation and marks the field as present.
CCCollectedDigits	setVoiceInformationPresent(boolean flag) Sets the presence or absence of the optional field voiceInformation.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CCCollectedDigits

public CCCollectedDigits()

Constructs an object with uninitialised state.

Method Detail

clone

public CCCollectedDigits clone()

Constructs a copy of this object and everything reachable from it.

Specified by:

clone in interface DataObject

Specified by:

clone in class AbstractDataObject

Returns:

copy of object

copyOf

public static CCCollectedDigits copyOf(CCCollectedDigits from)

Creates a new object of this type, cloning the values of common fields from the given object of any subclass of the same base type.

Parameters:

from - the object from which to copy

Returns:

CCCollectedDigits

getCancelDigit

public AddressDelimiter getCancelDigit()

Gets the value of the field cancelDigit.

Returns:

value of field cancelDigit, or null if not present

getEndOfReplyDigit

public AddressDelimiter getEndOfReplyDigit()

Gets the value of the field endOfReplyDigit.

Returns:

value of field endOfReplyDigit, or null if not present

getErrortreatment

public CCErrorTreatment getErrortreatment()

Gets the value of the field errortreatment.

Returns:

value of field errortreatment, or null if not present

getFieldAccessors

public static FieldAccessor[] getFieldAccessors()

Gets a new array of the accessors for fields of this type.

Returns:

FieldAccessor[]

getFieldsMap

public Map<String,Object> getFieldsMap(boolean withAbsents)

Gets a Map from field-name to field-value. For a field of primitive type, the field-value is boxed. For an absent optional field, the field-value is AbstractFieldsObject.FIELD_ABSENT. For an unitialised mandatory field, the field-value is AbstractFieldsObject.FIELD_UNINITIALISED.

Specified by:

getFieldsMap in class AbstractFieldsObject

Parameters:

withAbsents - whether to put absent optional fields into Map

Returns:

Map from field-name to field-value

getFirstDigitTimeOut

public int getFirstDigitTimeOut()

Gets the value of the field firstDigitTimeOut.

Returns:

value of field firstDigitTimeOut

getInterDigitTimeOut

public int getInterDigitTimeOut()

Gets the value of the field interDigitTimeOut.

Returns:

value of field interDigitTimeOut

getInterruptableAnnInd

public boolean getInterruptableAnnInd()

Gets the value of the field interruptableAnnInd.

Returns:

value of field interruptableAnnInd

getMaximumNbOfDigits

public int getMaximumNbOfDigits()

Gets the value of the field maximumNbOfDigits.

Returns:

value of field maximumNbOfDigits

getMinimumNbOfDigits

public int getMinimumNbOfDigits()

Gets the value of the field minimumNbOfDigits.

Returns:

value of field minimumNbOfDigits

getStartDigit

public AddressDelimiter getStartDigit()

Gets the value of the field startDigit.

Returns:

value of field startDigit, or null if not present

getVoiceBack

public boolean getVoiceBack()

Gets the value of the field voiceBack.

Returns:

value of field voiceBack

getVoiceInformation

public boolean getVoiceInformation()

Gets the value of the field voiceInformation.

Returns:

value of field voiceInformation

hasCancelDigit

public boolean hasCancelDigit()

Tests whether the field cancelDigit has a value.

Returns:

whether the field cancelDigit has a value

hasEndOfReplyDigit

public boolean hasEndOfReplyDigit()

Tests whether the field endOfReplyDigit has a value.

Returns:

whether the field endOfReplyDigit has a value

hasErrortreatment

public boolean hasErrortreatment()

Tests whether the field errortreatment has a value.

Returns:

whether the field errortreatment has a value

hasFirstDigitTimeOut

public boolean hasFirstDigitTimeOut()

Tests whether the field firstDigitTimeOut has a value.

Returns:

whether the field firstDigitTimeOut has a value

hasInterDigitTimeOut

public boolean hasInterDigitTimeOut()

Tests whether the field interDigitTimeOut has a value.

Returns:

whether the field interDigitTimeOut has a value

hasInterruptableAnnInd

public boolean hasInterruptableAnnInd()

Tests whether the field interruptableAnnInd has a value.

Returns:

whether the field interruptableAnnInd has a value

hasMaximumNbOfDigits

public boolean hasMaximumNbOfDigits()

Tests whether the field maximumNbOfDigits has a value.

Returns:

whether the field maximumNbOfDigits has a value

hasMinimumNbOfDigits

public boolean hasMinimumNbOfDigits()

Tests whether the field minimumNbOfDigits has a value.

Returns:

whether the field minimumNbOfDigits has a value

hasStartDigit

public boolean hasStartDigit()

Tests whether the field startDigit has a value.

Returns:

whether the field startDigit has a value

hasVoiceBack

public boolean hasVoiceBack()

Tests whether the field voiceBack has a value.

Returns:

whether the field voiceBack has a value

hasVoiceInformation

public boolean hasVoiceInformation()

Tests whether the field voiceInformation has a value.

Returns:

whether the field voiceInformation has a value

setCancelDigit

public CCCollectedDigits setCancelDigit(AddressDelimiter value)
                                 throws IllegalStateException

Sets the value of the field cancelDigit. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setEndOfReplyDigit

public CCCollectedDigits setEndOfReplyDigit(AddressDelimiter value)
                                     throws IllegalStateException

Sets the value of the field endOfReplyDigit. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setErrortreatment

public CCCollectedDigits setErrortreatment(CCErrorTreatment value)
                                    throws IllegalStateException

Sets the value of the field errortreatment. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setFirstDigitTimeOut

public CCCollectedDigits setFirstDigitTimeOut(int value)
                                       throws IllegalStateException

Sets the value of the field firstDigitTimeOut and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setFirstDigitTimeOutPresent

public CCCollectedDigits setFirstDigitTimeOutPresent(boolean flag)
                                              throws IllegalStateException

Sets the presence or absence of the optional field firstDigitTimeOut.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setInterDigitTimeOut

public CCCollectedDigits setInterDigitTimeOut(int value)
                                       throws IllegalStateException

Sets the value of the field interDigitTimeOut and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setInterDigitTimeOutPresent

public CCCollectedDigits setInterDigitTimeOutPresent(boolean flag)
                                              throws IllegalStateException

Sets the presence or absence of the optional field interDigitTimeOut.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setInterruptableAnnInd

public CCCollectedDigits setInterruptableAnnInd(boolean value)
                                         throws IllegalStateException

Sets the value of the field interruptableAnnInd and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setInterruptableAnnIndPresent

public CCCollectedDigits setInterruptableAnnIndPresent(boolean flag)
                                                throws IllegalStateException

Sets the presence or absence of the optional field interruptableAnnInd.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setMaximumNbOfDigits

public CCCollectedDigits setMaximumNbOfDigits(int value)
                                       throws IllegalStateException

Sets the value of the field maximumNbOfDigits and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setMinimumNbOfDigits

public CCCollectedDigits setMinimumNbOfDigits(int value)
                                       throws IllegalStateException

Sets the value of the field minimumNbOfDigits and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setMinimumNbOfDigitsPresent

public CCCollectedDigits setMinimumNbOfDigitsPresent(boolean flag)
                                              throws IllegalStateException

Sets the presence or absence of the optional field minimumNbOfDigits.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject

setStartDigit

public CCCollectedDigits setStartDigit(AddressDelimiter value)
                                throws IllegalStateException

Sets the value of the field startDigit. If null, marks the field as absent.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setVoiceBack

public CCCollectedDigits setVoiceBack(boolean value)
                               throws IllegalStateException

Sets the value of the field voiceBack and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setVoiceBackPresent

public CCCollectedDigits setVoiceBackPresent(boolean flag)
                                      throws IllegalStateException

Sets the presence or absence of the optional field voiceBack.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setVoiceInformation

public CCCollectedDigits setVoiceInformation(boolean value)
                                      throws IllegalStateException

Sets the value of the field voiceInformation and marks the field as present.

Parameters:

value - the new value for the field

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only

setVoiceInformationPresent

public CCCollectedDigits setVoiceInformationPresent(boolean flag)
                                             throws IllegalStateException

Sets the presence or absence of the optional field voiceInformation.

Parameters:

flag - either true if the field should be marked as present or false if the field should be marked as absent

Returns:

this

Throws:

IllegalStateException - if this instance has been marked as read-only