com.opencloud.slee.resources.cgin.cap_v4

Class CAP4BCSM_Failure

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP4BCSM_Failure

All Implemented Interfaces:

DataObject, Serializable

public class CAP4BCSM_Failure
extends AbstractFieldsObject

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

 BCSM-Failure ::=
     SEQUENCE {
         legID LegID 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
CAP4BCSM_Failure() Constructs an object with uninitialised state.

Method Summary

Methods

Modifier and Type	Method and Description
CAP4BCSM_Failure	clone() Constructs a copy of this object and everything reachable from it.
static CAP4BCSM_Failure	copyOf(CAP4BCSM_Failure 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.
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.
CCLegID	getLegID() Gets the value of the field legID.
boolean	hasCause() Tests whether the field cause has a value.
boolean	hasLegID() Tests whether the field legID has a value.
CAP4BCSM_Failure	setCause(Cause value) Sets the value of the field cause.
CAP4BCSM_Failure	setLegID(CCLegID value) Sets the value of the field legID.
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

CAP4BCSM_Failure

public CAP4BCSM_Failure()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP4BCSM_Failure

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

getLegID

public CCLegID getLegID()

Gets the value of the field legID.

Returns:

value of field legID, or null if not present

hasCause

public boolean hasCause()

Tests whether the field cause has a value.

Returns:

whether the field cause has a value

hasLegID

public boolean hasLegID()

Tests whether the field legID has a value.

Returns:

whether the field legID has a value

setCause

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

setLegID

public CAP4BCSM_Failure setLegID(CCLegID value)
                          throws IllegalStateException

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