com.opencloud.slee.resources.cgin.callcontrol

Class CCTone

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCTone

All Implemented Interfaces:

DataObject, Serializable

public class CCTone
extends AbstractFieldsObject

API for CC-DataTypes.Tone. Generated from the following ASN.1 type definition.

 Tone ::=
     SEQUENCE {
         toneID   Integer4,
         duration Integer4 OPTIONAL
     }
 

Used as field type by CCInformationToSend.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CCTone	clone() Constructs a copy of this object and everything reachable from it.
static CCTone	copyOf(CCTone 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.
int	getDuration() Gets the value of the field duration.
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	getToneID() Gets the value of the field toneID.
boolean	hasDuration() Tests whether the field duration has a value.
boolean	hasToneID() Tests whether the field toneID has a value.
CCTone	setDuration(int value) Sets the value of the field duration and marks the field as present.
CCTone	setDurationPresent(boolean flag) Sets the presence or absence of the optional field duration.
CCTone	setToneID(int value) Sets the value of the field toneID and marks the field as present.

Methods inherited from class com.opencloud.util.AbstractFieldsObject

equals, hashCode, toString

Methods inherited from class com.opencloud.util.AbstractDataObject

checkModify, isReadOnly, setReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

CCTone

public CCTone()

Constructs an object with uninitialised state.

Method Detail

clone

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

CCTone

getDuration

public int getDuration()

Gets the value of the field duration.

Returns:

value of field duration

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

getToneID

public int getToneID()

Gets the value of the field toneID.

Returns:

value of field toneID

hasDuration

public boolean hasDuration()

Tests whether the field duration has a value.

Returns:

whether the field duration has a value

hasToneID

public boolean hasToneID()

Tests whether the field toneID has a value.

Returns:

whether the field toneID has a value

setDuration

public CCTone setDuration(int value)
                   throws IllegalStateException

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

setDurationPresent

public CCTone setDurationPresent(boolean flag)
                          throws IllegalStateException

Sets the presence or absence of the optional field duration.

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

setToneID

public CCTone setToneID(int value)
                 throws IllegalStateException

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