com.opencloud.slee.resources.cgin.cap_v4

Class CAP4MidCallControlInfo

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4MidCallControlInfo

All Implemented Interfaces:

DataObject, Serializable

public class CAP4MidCallControlInfo
extends AbstractFieldsObject

API for CAP-datatypes.MidCallControlInfo. Generated from the following ASN.1 type definition and the adaptations below.

 MidCallControlInfo ::=
     SEQUENCE {
         minimumNumberOfDigits INTEGER (1..30) DEFAULT 1,
         maximumNumberOfDigits INTEGER (1..30) DEFAULT 30,
         endOfReplyDigit       OCTET STRING (SIZE (1..2)) OPTIONAL,
         cancelDigit           OCTET STRING (SIZE (1..2)) OPTIONAL,
         startDigit            OCTET STRING (SIZE (1..2)) OPTIONAL,
         interDigitTimeout     INTEGER (1..127) DEFAULT 10,
         ...
     }
 CAP-datatypes {
     MidCallControlInfo {
         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 CAP4DpSpecificCriteria.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4MidCallControlInfo	clone() Constructs a copy of this object and everything reachable from it.
static CAP4MidCallControlInfo	copyOf(CAP4MidCallControlInfo 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.
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	getInterDigitTimeout() Gets the value of the field interDigitTimeout.
int	getMaximumNumberOfDigits() Gets the value of the field maximumNumberOfDigits.
int	getMinimumNumberOfDigits() Gets the value of the field minimumNumberOfDigits.
AddressDelimiter	getStartDigit() Gets the value of the field startDigit.
boolean	hasCancelDigit() Tests whether the field cancelDigit has a value.
boolean	hasEndOfReplyDigit() Tests whether the field endOfReplyDigit has a value.
boolean	hasInterDigitTimeout() Tests whether the field interDigitTimeout has a value.
boolean	hasMaximumNumberOfDigits() Tests whether the field maximumNumberOfDigits has a value.
boolean	hasMinimumNumberOfDigits() Tests whether the field minimumNumberOfDigits has a value.
boolean	hasStartDigit() Tests whether the field startDigit has a value.
CAP4MidCallControlInfo	setCancelDigit(AddressDelimiter value) Sets the value of the field cancelDigit.
CAP4MidCallControlInfo	setEndOfReplyDigit(AddressDelimiter value) Sets the value of the field endOfReplyDigit.
CAP4MidCallControlInfo	setInterDigitTimeout(int value) Sets the value of the field interDigitTimeout and marks the field as present.
CAP4MidCallControlInfo	setInterDigitTimeoutPresent(boolean flag) Sets the presence or absence of the optional field interDigitTimeout.
CAP4MidCallControlInfo	setMaximumNumberOfDigits(int value) Sets the value of the field maximumNumberOfDigits and marks the field as present.
CAP4MidCallControlInfo	setMaximumNumberOfDigitsPresent(boolean flag) Sets the presence or absence of the optional field maximumNumberOfDigits.
CAP4MidCallControlInfo	setMinimumNumberOfDigits(int value) Sets the value of the field minimumNumberOfDigits and marks the field as present.
CAP4MidCallControlInfo	setMinimumNumberOfDigitsPresent(boolean flag) Sets the presence or absence of the optional field minimumNumberOfDigits.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4MidCallControlInfo	setStartDigit(AddressDelimiter value) Sets the value of the field startDigit.

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

CAP4MidCallControlInfo

public CAP4MidCallControlInfo()

Constructs an object with uninitialised state.

Method Detail

clone

public CAP4MidCallControlInfo 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 CAP4MidCallControlInfo copyOf(CAP4MidCallControlInfo 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:

CAP4MidCallControlInfo

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

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

getInterDigitTimeout

public int getInterDigitTimeout()

Gets the value of the field interDigitTimeout.

Returns:

value of field interDigitTimeout

getMaximumNumberOfDigits

public int getMaximumNumberOfDigits()

Gets the value of the field maximumNumberOfDigits.

Returns:

value of field maximumNumberOfDigits

getMinimumNumberOfDigits

public int getMinimumNumberOfDigits()

Gets the value of the field minimumNumberOfDigits.

Returns:

value of field minimumNumberOfDigits

getStartDigit

public AddressDelimiter getStartDigit()

Gets the value of the field startDigit.

Returns:

value of field startDigit, or null if not present

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

hasInterDigitTimeout

public boolean hasInterDigitTimeout()

Tests whether the field interDigitTimeout has a value.

Returns:

whether the field interDigitTimeout has a value

hasMaximumNumberOfDigits

public boolean hasMaximumNumberOfDigits()

Tests whether the field maximumNumberOfDigits has a value.

Returns:

whether the field maximumNumberOfDigits has a value

hasMinimumNumberOfDigits

public boolean hasMinimumNumberOfDigits()

Tests whether the field minimumNumberOfDigits has a value.

Returns:

whether the field minimumNumberOfDigits has a value

hasStartDigit

public boolean hasStartDigit()

Tests whether the field startDigit has a value.

Returns:

whether the field startDigit has a value

setCancelDigit

public CAP4MidCallControlInfo 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 CAP4MidCallControlInfo 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

setInterDigitTimeout

public CAP4MidCallControlInfo 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 CAP4MidCallControlInfo 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

setMaximumNumberOfDigits

public CAP4MidCallControlInfo setMaximumNumberOfDigits(int value)
                                                throws IllegalStateException

Sets the value of the field maximumNumberOfDigits 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

setMaximumNumberOfDigitsPresent

public CAP4MidCallControlInfo setMaximumNumberOfDigitsPresent(boolean flag)
                                                       throws IllegalStateException

Sets the presence or absence of the optional field maximumNumberOfDigits.

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

setMinimumNumberOfDigits

public CAP4MidCallControlInfo setMinimumNumberOfDigits(int value)
                                                throws IllegalStateException

Sets the value of the field minimumNumberOfDigits 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

setMinimumNumberOfDigitsPresent

public CAP4MidCallControlInfo setMinimumNumberOfDigitsPresent(boolean flag)
                                                       throws IllegalStateException

Sets the presence or absence of the optional field minimumNumberOfDigits.

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 CAP4MidCallControlInfo 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