com.opencloud.slee.resources.cgin.map

Class MAPLocationType

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPLocationType

All Implemented Interfaces:

DataObject, Serializable

public class MAPLocationType
extends AbstractFieldsObject

API for MAP-LCS-DataTypes.LocationType. Generated from the following ASN.1 type definition.

 LocationType ::=
     SEQUENCE {
         locationEstimateType      LocationEstimateType,
         ...
         deferredLocationEventType DeferredLocationEventType OPTIONAL -- Added in release 4.
     }
 

Added in R98.

Used as field type by MAPProvideSubscriberLocation_Arg.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPLocationType	clone() Constructs a copy of this object and everything reachable from it.
static MAPLocationType	copyOf(MAPLocationType 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.
MAPDeferredLocationEventType	getDeferredLocationEventType() Gets the value of the field deferredLocationEventType.
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.
MAPLocationEstimateType	getLocationEstimateType() Gets the value of the field locationEstimateType.
boolean	hasDeferredLocationEventType() Tests whether the field deferredLocationEventType has a value.
boolean	hasLocationEstimateType() Tests whether the field locationEstimateType has a value.
MAPLocationType	setDeferredLocationEventType(MAPDeferredLocationEventType value) Sets the value of the field deferredLocationEventType.
MAPLocationType	setLocationEstimateType(MAPLocationEstimateType value) Sets the value of the field locationEstimateType.
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

MAPLocationType

public MAPLocationType()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPLocationType

getDeferredLocationEventType

public MAPDeferredLocationEventType getDeferredLocationEventType()

Gets the value of the field deferredLocationEventType.

Returns:

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

getLocationEstimateType

public MAPLocationEstimateType getLocationEstimateType()

Gets the value of the field locationEstimateType.

Returns:

value of field locationEstimateType, or null if not present

hasDeferredLocationEventType

public boolean hasDeferredLocationEventType()

Tests whether the field deferredLocationEventType has a value.

Returns:

whether the field deferredLocationEventType has a value

hasLocationEstimateType

public boolean hasLocationEstimateType()

Tests whether the field locationEstimateType has a value.

Returns:

whether the field locationEstimateType has a value

setDeferredLocationEventType

public MAPLocationType setDeferredLocationEventType(MAPDeferredLocationEventType value)
                                             throws IllegalStateException

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

setLocationEstimateType

public MAPLocationType setLocationEstimateType(MAPLocationEstimateType value)
                                        throws IllegalStateException

Sets the value of the field locationEstimateType.

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