com.opencloud.slee.resources.cgin.cap_v4

Class CAP4CallSegmentFailure

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4CallSegmentFailure

All Implemented Interfaces:

DataObject, Serializable

public class CAP4CallSegmentFailure
extends AbstractFieldsObject

API for CAP-datatypes.CallSegmentFailure. Generated from the following ASN.1 type definition.

 CallSegmentFailure ::=
     SEQUENCE {
         callSegmentID CallSegmentID OPTIONAL,
         cause         Cause OPTIONAL,
         ...
     }
 

Used as field type by CAP4EntityReleasedArg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4CallSegmentFailure	clone() Constructs a copy of this object and everything reachable from it.
static CAP4CallSegmentFailure	copyOf(CAP4CallSegmentFailure 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	getCallSegmentID() Gets the value of the field callSegmentID.
Cause	getCause() Gets the value of the field cause.
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.
boolean	hasCallSegmentID() Tests whether the field callSegmentID has a value.
boolean	hasCause() Tests whether the field cause has a value.
CAP4CallSegmentFailure	setCallSegmentID(int value) Sets the value of the field callSegmentID and marks the field as present.
CAP4CallSegmentFailure	setCallSegmentIDPresent(boolean flag) Sets the presence or absence of the optional field callSegmentID.
CAP4CallSegmentFailure	setCause(Cause value) Sets the value of the field cause.
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

CAP4CallSegmentFailure

public CAP4CallSegmentFailure()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4CallSegmentFailure

getCallSegmentID

public int getCallSegmentID()

Gets the value of the field callSegmentID.

Returns:

value of field callSegmentID

getCause

public Cause getCause()

Gets the value of the field cause.

Returns:

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

hasCallSegmentID

public boolean hasCallSegmentID()

Tests whether the field callSegmentID has a value.

Returns:

whether the field callSegmentID has a value

hasCause

public boolean hasCause()

Tests whether the field cause has a value.

Returns:

whether the field cause has a value

setCallSegmentID

public CAP4CallSegmentFailure setCallSegmentID(int value)
                                        throws IllegalStateException

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

setCallSegmentIDPresent

public CAP4CallSegmentFailure setCallSegmentIDPresent(boolean flag)
                                               throws IllegalStateException

Sets the presence or absence of the optional field callSegmentID.

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

setCause

public CAP4CallSegmentFailure setCause(Cause value)
                                throws IllegalStateException

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