com.opencloud.slee.resources.cgin.map

Class MAPLocationInformationEPS

java.lang.Object

com.opencloud.util.AbstractDataObject

com.opencloud.util.AbstractFieldsObject

MAPLocationInformationEPS

All Implemented Interfaces:

DataObject, Serializable

public class MAPLocationInformationEPS
extends AbstractFieldsObject

API for MAP-MS-DataTypes.LocationInformationEPS. Generated from the following ASN.1 type definition.

 LocationInformationEPS ::=
     SEQUENCE {
         e-utranCellGlobalIdentity OCTET STRING (SIZE (7)) OPTIONAL,
         trackingAreaIdentity      OCTET STRING (SIZE (5)) OPTIONAL,
         extensionContainer        ExtensionContainer OPTIONAL,
         geographicalInformation   GeographicalInformation OPTIONAL,
         geodeticInformation       GeodeticInformation OPTIONAL,
         currentLocationRetrieved  NULL OPTIONAL,
         ageOfLocationInformation  AgeOfLocationInformation OPTIONAL,
         ...
     }
 

Added in release 9. currentLocationRetrieved shall be present if the location information was retrieved after successful paging.

Used as field type by MAPLocationInformation.

Used as field type by MAPSubscriberInfo.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.opencloud.util.AbstractFieldsObject

FIELD_ABSENT, FIELD_UNINITIALISED

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
MAPLocationInformationEPS	clone() Constructs a copy of this object and everything reachable from it.
static MAPLocationInformationEPS	copyOf(MAPLocationInformationEPS 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.
int	getAgeOfLocationInformation() Gets the value of the field ageOfLocationInformation.
byte[]	getE_utranCellGlobalIdentity() Gets the value of the field e-utranCellGlobalIdentity.
MAPExtensionContainer	getExtensionContainer() Gets the value of the field extensionContainer.
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.
byte[]	getGeodeticInformation() Gets the value of the field geodeticInformation.
byte[]	getGeographicalInformation() Gets the value of the field geographicalInformation.
byte[]	getTrackingAreaIdentity() Gets the value of the field trackingAreaIdentity.
boolean	hasAgeOfLocationInformation() Tests whether the field ageOfLocationInformation has a value.
boolean	hasCurrentLocationRetrieved() Tests whether the field currentLocationRetrieved is present.
boolean	hasE_utranCellGlobalIdentity() Tests whether the field e-utranCellGlobalIdentity has a value.
boolean	hasExtensionContainer() Tests whether the field extensionContainer has a value.
boolean	hasGeodeticInformation() Tests whether the field geodeticInformation has a value.
boolean	hasGeographicalInformation() Tests whether the field geographicalInformation has a value.
boolean	hasTrackingAreaIdentity() Tests whether the field trackingAreaIdentity has a value.
MAPLocationInformationEPS	setAgeOfLocationInformation(int value) Sets the value of the field ageOfLocationInformation and marks the field as present.
MAPLocationInformationEPS	setAgeOfLocationInformationPresent(boolean flag) Sets the presence or absence of the optional field ageOfLocationInformation.
MAPLocationInformationEPS	setCurrentLocationRetrievedPresent(boolean flag) Sets the presence or absence of the optional field currentLocationRetrieved.
MAPLocationInformationEPS	setE_utranCellGlobalIdentity(byte[] value) Sets the value of the field e-utranCellGlobalIdentity.
MAPLocationInformationEPS	setExtensionContainer(MAPExtensionContainer value) Sets the value of the field extensionContainer.
MAPLocationInformationEPS	setGeodeticInformation(byte[] value) Sets the value of the field geodeticInformation.
MAPLocationInformationEPS	setGeographicalInformation(byte[] value) Sets the value of the field geographicalInformation.
void	setReadOnly() Sets this and all its fields to be immutable.
MAPLocationInformationEPS	setTrackingAreaIdentity(byte[] value) Sets the value of the field trackingAreaIdentity.

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

MAPLocationInformationEPS

public MAPLocationInformationEPS()

Constructs an object with uninitialised state.

Method Detail

clone

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

MAPLocationInformationEPS

getAgeOfLocationInformation

public int getAgeOfLocationInformation()

Gets the value of the field ageOfLocationInformation.

Returns:

value of field ageOfLocationInformation

getE_utranCellGlobalIdentity

public byte[] getE_utranCellGlobalIdentity()

Gets the value of the field e-utranCellGlobalIdentity.

Returns:

value of field e-utranCellGlobalIdentity, or null if not present

getExtensionContainer

public MAPExtensionContainer getExtensionContainer()

Gets the value of the field extensionContainer.

Returns:

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

getGeodeticInformation

public byte[] getGeodeticInformation()

Gets the value of the field geodeticInformation.

Returns:

value of field geodeticInformation, or null if not present

getGeographicalInformation

public byte[] getGeographicalInformation()

Gets the value of the field geographicalInformation.

Returns:

value of field geographicalInformation, or null if not present

getTrackingAreaIdentity

public byte[] getTrackingAreaIdentity()

Gets the value of the field trackingAreaIdentity.

Returns:

value of field trackingAreaIdentity, or null if not present

hasAgeOfLocationInformation

public boolean hasAgeOfLocationInformation()

Tests whether the field ageOfLocationInformation has a value.

Returns:

whether the field ageOfLocationInformation has a value

hasCurrentLocationRetrieved

public boolean hasCurrentLocationRetrieved()

Tests whether the field currentLocationRetrieved is present.

Returns:

whether the field currentLocationRetrieved is present

hasE_utranCellGlobalIdentity

public boolean hasE_utranCellGlobalIdentity()

Tests whether the field e-utranCellGlobalIdentity has a value.

Returns:

whether the field e-utranCellGlobalIdentity has a value

hasExtensionContainer

public boolean hasExtensionContainer()

Tests whether the field extensionContainer has a value.

Returns:

whether the field extensionContainer has a value

hasGeodeticInformation

public boolean hasGeodeticInformation()

Tests whether the field geodeticInformation has a value.

Returns:

whether the field geodeticInformation has a value

hasGeographicalInformation

public boolean hasGeographicalInformation()

Tests whether the field geographicalInformation has a value.

Returns:

whether the field geographicalInformation has a value

hasTrackingAreaIdentity

public boolean hasTrackingAreaIdentity()

Tests whether the field trackingAreaIdentity has a value.

Returns:

whether the field trackingAreaIdentity has a value

setAgeOfLocationInformation

public MAPLocationInformationEPS setAgeOfLocationInformation(int value)
                                                      throws IllegalStateException

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

setAgeOfLocationInformationPresent

public MAPLocationInformationEPS setAgeOfLocationInformationPresent(boolean flag)
                                                             throws IllegalStateException

Sets the presence or absence of the optional field ageOfLocationInformation.

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

setCurrentLocationRetrievedPresent

public MAPLocationInformationEPS setCurrentLocationRetrievedPresent(boolean flag)
                                                             throws IllegalStateException

Sets the presence or absence of the optional field currentLocationRetrieved.

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

setE_utranCellGlobalIdentity

public MAPLocationInformationEPS setE_utranCellGlobalIdentity(byte[] value)
                                                       throws IllegalStateException

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

setExtensionContainer

public MAPLocationInformationEPS setExtensionContainer(MAPExtensionContainer value)
                                                throws IllegalStateException

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

setGeodeticInformation

public MAPLocationInformationEPS setGeodeticInformation(byte[] value)
                                                 throws IllegalStateException

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

setGeographicalInformation

public MAPLocationInformationEPS setGeographicalInformation(byte[] value)
                                                     throws IllegalStateException

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

setTrackingAreaIdentity

public MAPLocationInformationEPS setTrackingAreaIdentity(byte[] value)
                                                  throws IllegalStateException

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