com.opencloud.slee.resources.cgin.cap_v4

Class CAP4PlayToneArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4PlayToneArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4PlayToneArg
extends AbstractFieldsObject

API for CAP-gsmSSF-gsmSCF-ops-args.PlayToneArg. Generated from the following ASN.1 type definition.

 PlayToneArg ::=
     SEQUENCE {
         legOrCallSegment LegOrCallSegment,
         bursts           Burst,
         extensions       Extensions OPTIONAL,
         ...
     }
 

Used as argument type by CAP4Operations.playTone.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4PlayToneArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4PlayToneArg	copyOf(CAP4PlayToneArg 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.
CAP4Burst	getBursts() Gets the value of the field bursts.
CAP1ExtensionField[]	getExtensions() Gets the value of the field extensions.
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.
CAP4LegOrCallSegment	getLegOrCallSegment() Gets the value of the field legOrCallSegment.
boolean	hasBursts() Tests whether the field bursts has a value.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasLegOrCallSegment() Tests whether the field legOrCallSegment has a value.
CAP4PlayToneArg	setBursts(CAP4Burst value) Sets the value of the field bursts.
CAP4PlayToneArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4PlayToneArg	setLegOrCallSegment(CAP4LegOrCallSegment value) Sets the value of the field legOrCallSegment.
void	setReadOnly() Sets this and all its fields to be immutable.

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

CAP4PlayToneArg

public CAP4PlayToneArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4PlayToneArg

getBursts

public CAP4Burst getBursts()

Gets the value of the field bursts.

Returns:

value of field bursts, or null if not present

getExtensions

public CAP1ExtensionField[] getExtensions()

Gets the value of the field extensions.

Returns:

value of field extensions, 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

getLegOrCallSegment

public CAP4LegOrCallSegment getLegOrCallSegment()

Gets the value of the field legOrCallSegment.

Returns:

value of field legOrCallSegment, or null if not present

hasBursts

public boolean hasBursts()

Tests whether the field bursts has a value.

Returns:

whether the field bursts has a value

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasLegOrCallSegment

public boolean hasLegOrCallSegment()

Tests whether the field legOrCallSegment has a value.

Returns:

whether the field legOrCallSegment has a value

setBursts

public CAP4PlayToneArg setBursts(CAP4Burst value)
                          throws IllegalStateException

Sets the value of the field bursts.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setExtensions

public CAP4PlayToneArg setExtensions(CAP1ExtensionField[] value)
                              throws IllegalStateException

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

setLegOrCallSegment

public CAP4PlayToneArg setLegOrCallSegment(CAP4LegOrCallSegment value)
                                    throws IllegalStateException

Sets the value of the field legOrCallSegment.

Parameters:

value - the new value for the field

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