com.opencloud.slee.resources.cgin.cap_v4

Class CAP4SplitLegArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4SplitLegArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4SplitLegArg
extends AbstractFieldsObject

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

 SplitLegArg ::=
     SEQUENCE {
         legToBeSplit   LegID,
         newCallSegment CallSegmentID OPTIONAL,
         extensions     Extensions OPTIONAL,
         ...
     }
 

Used as argument type by CAP4Operations.splitLeg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4SplitLegArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4SplitLegArg	copyOf(CAP4SplitLegArg 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.
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.
CCLegID	getLegToBeSplit() Gets the value of the field legToBeSplit.
int	getNewCallSegment() Gets the value of the field newCallSegment.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasLegToBeSplit() Tests whether the field legToBeSplit has a value.
boolean	hasNewCallSegment() Tests whether the field newCallSegment has a value.
CAP4SplitLegArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4SplitLegArg	setLegToBeSplit(CCLegID value) Sets the value of the field legToBeSplit.
CAP4SplitLegArg	setNewCallSegment(int value) Sets the value of the field newCallSegment and marks the field as present.
CAP4SplitLegArg	setNewCallSegmentPresent(boolean flag) Sets the presence or absence of the optional field newCallSegment.
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

CAP4SplitLegArg

public CAP4SplitLegArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4SplitLegArg

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

getLegToBeSplit

public CCLegID getLegToBeSplit()

Gets the value of the field legToBeSplit.

Returns:

value of field legToBeSplit, or null if not present

getNewCallSegment

public int getNewCallSegment()

Gets the value of the field newCallSegment.

Returns:

value of field newCallSegment

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasLegToBeSplit

public boolean hasLegToBeSplit()

Tests whether the field legToBeSplit has a value.

Returns:

whether the field legToBeSplit has a value

hasNewCallSegment

public boolean hasNewCallSegment()

Tests whether the field newCallSegment has a value.

Returns:

whether the field newCallSegment has a value

setExtensions

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

setLegToBeSplit

public CAP4SplitLegArg setLegToBeSplit(CCLegID value)
                                throws IllegalStateException

Sets the value of the field legToBeSplit.

Parameters:

value - the new value for the field

Returns:

this

Throws:

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

setNewCallSegment

public CAP4SplitLegArg setNewCallSegment(int value)
                                  throws IllegalStateException

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

setNewCallSegmentPresent

public CAP4SplitLegArg setNewCallSegmentPresent(boolean flag)
                                         throws IllegalStateException

Sets the presence or absence of the optional field newCallSegment.

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