com.opencloud.slee.resources.cgin.cap_v4

Class CAP4DisconnectLegArg

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4DisconnectLegArg

All Implemented Interfaces:

DataObject, Serializable

public class CAP4DisconnectLegArg
extends AbstractFieldsObject

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

 DisconnectLegArg ::=
     SEQUENCE {
         legToBeReleased LegID,
         releaseCause    Cause OPTIONAL,
         extensions      Extensions OPTIONAL,
         ...
     }
 

Used as argument type by CAP4Operations.disconnectLeg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP4DisconnectLegArg	clone() Constructs a copy of this object and everything reachable from it.
static CAP4DisconnectLegArg	copyOf(CAP4DisconnectLegArg 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	getLegToBeReleased() Gets the value of the field legToBeReleased.
Cause	getReleaseCause() Gets the value of the field releaseCause.
boolean	hasExtensions() Tests whether the field extensions has a value.
boolean	hasLegToBeReleased() Tests whether the field legToBeReleased has a value.
boolean	hasReleaseCause() Tests whether the field releaseCause has a value.
CAP4DisconnectLegArg	setExtensions(CAP1ExtensionField[] value) Sets the value of the field extensions.
CAP4DisconnectLegArg	setLegToBeReleased(CCLegID value) Sets the value of the field legToBeReleased.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP4DisconnectLegArg	setReleaseCause(Cause value) Sets the value of the field releaseCause.

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

CAP4DisconnectLegArg

public CAP4DisconnectLegArg()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4DisconnectLegArg

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

getLegToBeReleased

public CCLegID getLegToBeReleased()

Gets the value of the field legToBeReleased.

Returns:

value of field legToBeReleased, or null if not present

getReleaseCause

public Cause getReleaseCause()

Gets the value of the field releaseCause.

Returns:

value of field releaseCause, or null if not present

hasExtensions

public boolean hasExtensions()

Tests whether the field extensions has a value.

Returns:

whether the field extensions has a value

hasLegToBeReleased

public boolean hasLegToBeReleased()

Tests whether the field legToBeReleased has a value.

Returns:

whether the field legToBeReleased has a value

hasReleaseCause

public boolean hasReleaseCause()

Tests whether the field releaseCause has a value.

Returns:

whether the field releaseCause has a value

setExtensions

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

setLegToBeReleased

public CAP4DisconnectLegArg setLegToBeReleased(CCLegID value)
                                        throws IllegalStateException

Sets the value of the field legToBeReleased.

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

setReleaseCause

public CAP4DisconnectLegArg setReleaseCause(Cause value)
                                     throws IllegalStateException

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