com.opencloud.slee.resources.cgin.cap_v3

Class CAP3CompoundCriteria

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

CAP3CompoundCriteria

All Implemented Interfaces:

DataObject, Serializable

public class CAP3CompoundCriteria
extends AbstractFieldsObject

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

 CompoundCriteria ::=
     SEQUENCE {
         basicGapCriteria BasicGapCriteria,
         scfID            ScfID OPTIONAL
     }
 

Used as field type by CAP3GapCriteria.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
CAP3CompoundCriteria	clone() Constructs a copy of this object and everything reachable from it.
static CAP3CompoundCriteria	copyOf(CAP3CompoundCriteria 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.
CCBasicGapCriteria	getBasicGapCriteria() Gets the value of the field basicGapCriteria.
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.
CCScfID	getScfID() Gets the value of the field scfID.
boolean	hasBasicGapCriteria() Tests whether the field basicGapCriteria has a value.
boolean	hasScfID() Tests whether the field scfID has a value.
CAP3CompoundCriteria	setBasicGapCriteria(CCBasicGapCriteria value) Sets the value of the field basicGapCriteria.
void	setReadOnly() Sets this and all its fields to be immutable.
CAP3CompoundCriteria	setScfID(CCScfID value) Sets the value of the field scfID.

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

CAP3CompoundCriteria

public CAP3CompoundCriteria()

Constructs an object with uninitialised state.

Method Detail

clone

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

CAP3CompoundCriteria

getBasicGapCriteria

public CCBasicGapCriteria getBasicGapCriteria()

Gets the value of the field basicGapCriteria.

Returns:

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

getScfID

public CCScfID getScfID()

Gets the value of the field scfID.

Returns:

value of field scfID, or null if not present

hasBasicGapCriteria

public boolean hasBasicGapCriteria()

Tests whether the field basicGapCriteria has a value.

Returns:

whether the field basicGapCriteria has a value

hasScfID

public boolean hasScfID()

Tests whether the field scfID has a value.

Returns:

whether the field scfID has a value

setBasicGapCriteria

public CAP3CompoundCriteria setBasicGapCriteria(CCBasicGapCriteria value)
                                         throws IllegalStateException

Sets the value of the field basicGapCriteria.

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

setScfID

public CAP3CompoundCriteria setScfID(CCScfID value)
                              throws IllegalStateException

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