com.opencloud.slee.resources.cgin.callcontrol

Class CCCallGapArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CCCallGapArg

All Implemented Interfaces:

DataObject, Serializable

Direct Known Subclasses:

CAP3CallGapArg, CS1CallGapArg

public class CCCallGapArg
extends AbstractFieldsObject

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

 CallGapArg ::=
     SEQUENCE {
         gapCriteria   GapCriteria,
         gapIndicators GapIndicators,
         controlType   ControlType OPTIONAL,
         gapTreatment  GapTreatment OPTIONAL
     }
 

Used as argument type by CCOperations.callGap.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CCCallGapArg	clone() Constructs a copy of this object and everything reachable from it.
static CCCallGapArg	copyOf(CCCallGapArg 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.
CCControlType	getControlType() Gets the value of the field controlType.
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.
CCGapCriteria	getGapCriteria() Gets the value of the field gapCriteria.
CCGapIndicators	getGapIndicators() Gets the value of the field gapIndicators.
CCGapTreatment	getGapTreatment() Gets the value of the field gapTreatment.
boolean	hasControlType() Tests whether the field controlType has a value.
boolean	hasGapCriteria() Tests whether the field gapCriteria has a value.
boolean	hasGapIndicators() Tests whether the field gapIndicators has a value.
boolean	hasGapTreatment() Tests whether the field gapTreatment has a value.
CCCallGapArg	setControlType(CCControlType value) Sets the value of the field controlType.
CCCallGapArg	setGapCriteria(CCGapCriteria value) Sets the value of the field gapCriteria.
CCCallGapArg	setGapIndicators(CCGapIndicators value) Sets the value of the field gapIndicators.
CCCallGapArg	setGapTreatment(CCGapTreatment value) Sets the value of the field gapTreatment.
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

CCCallGapArg

public CCCallGapArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CCCallGapArg

getControlType

public CCControlType getControlType()

Gets the value of the field controlType.

Returns:

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

getGapCriteria

public CCGapCriteria getGapCriteria()

Gets the value of the field gapCriteria.

Returns:

value of field gapCriteria, or null if not present

getGapIndicators

public CCGapIndicators getGapIndicators()

Gets the value of the field gapIndicators.

Returns:

value of field gapIndicators, or null if not present

getGapTreatment

public CCGapTreatment getGapTreatment()

Gets the value of the field gapTreatment.

Returns:

value of field gapTreatment, or null if not present

hasControlType

public boolean hasControlType()

Tests whether the field controlType has a value.

Returns:

whether the field controlType has a value

hasGapCriteria

public boolean hasGapCriteria()

Tests whether the field gapCriteria has a value.

Returns:

whether the field gapCriteria has a value

hasGapIndicators

public boolean hasGapIndicators()

Tests whether the field gapIndicators has a value.

Returns:

whether the field gapIndicators has a value

hasGapTreatment

public boolean hasGapTreatment()

Tests whether the field gapTreatment has a value.

Returns:

whether the field gapTreatment has a value

setControlType

public CCCallGapArg setControlType(CCControlType value)
                            throws IllegalStateException

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

setGapCriteria

public CCCallGapArg setGapCriteria(CCGapCriteria value)
                            throws IllegalStateException

Sets the value of the field gapCriteria.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGapIndicators

public CCCallGapArg setGapIndicators(CCGapIndicators value)
                              throws IllegalStateException

Sets the value of the field gapIndicators.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setGapTreatment

public CCCallGapArg setGapTreatment(CCGapTreatment value)
                             throws IllegalStateException

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

setReadOnly

public void setReadOnly()

Sets this and all its fields to be immutable.

Specified by:

setReadOnly in interface DataObject

Overrides:

setReadOnly in class AbstractDataObject