Class MAPLocationInformation
- java.lang.Object
-
- com.opencloud.util.AbstractDataObject
-
- com.opencloud.util.AbstractFieldsObject
-
- MAPLocationInformation
-
- All Implemented Interfaces:
DataObject
,Serializable
public class MAPLocationInformation extends AbstractFieldsObject
API for MAP-MS-DataTypes.LocationInformation. Generated from the following ASN.1 type definition.LocationInformation ::= SEQUENCE { ageOfLocationInformation AgeOfLocationInformation OPTIONAL, geographicalInformation GeographicalInformation OPTIONAL, vlr-number ISDN-AddressString OPTIONAL, locationNumber LocationNumber OPTIONAL, cellGlobalIdOrServiceAreaIdOrLAI CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, -- Renamed from cellIdOrLAI between R98 and R99. extensionContainer ExtensionContainer OPTIONAL, ... selectedLSA-Id LSAIdentity OPTIONAL, -- Added in R99. msc-Number ISDN-AddressString OPTIONAL, -- Added in R99. geodeticInformation GeodeticInformation OPTIONAL, -- Added in R99. currentLocationRetrieved NULL OPTIONAL, -- Added in R99. sai-Present NULL OPTIONAL, -- Added in R99. locationInformationEPS LocationInformationEPS OPTIONAL, -- Added in release 9. userCSGInformation UserCSGInformation OPTIONAL -- Added in release 9. }
Added in R96. sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains a Service Area Identity. currentLocationRetrieved shall be present if the location information were retrieved after a successfull paging. If the locationinformationEPS IE is present then the cellGlobalIdOrServiceAreaIdOrLAI IE shall be absent. UserCSGInformation contains the CSG ID, Access mode, and the CSG Membership Indication in the case the Access mode is Hybrid Mode.Used as field type by
MAPSubscriberInfo
.Used as field type by
MAPNoteMM_EventArg
.- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.opencloud.util.AbstractFieldsObject
FIELD_ABSENT, FIELD_UNINITIALISED
-
-
Constructor Summary
Constructors Constructor Description MAPLocationInformation()
Constructs an object with uninitialised state.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description MAPLocationInformation
clone()
Constructs a copy of this object and everything reachable from it.static MAPLocationInformation
copyOf(MAPLocationInformation 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.MAPCellGlobalIdOrServiceAreaIdOrLAI
getCellGlobalIdOrServiceAreaIdOrLAI()
Gets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.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.MAPLocationInformationEPS
getLocationInformationEPS()
Gets the value of the field locationInformationEPS.LocationNumber
getLocationNumber()
Gets the value of the field locationNumber.AddressString
getMsc_Number()
Gets the value of the field msc-Number.LocalisedServiceAreaId
getSelectedLSA_Id()
Gets the value of the field selectedLSA-Id.MAPUserCSGInformation
getUserCSGInformation()
Gets the value of the field userCSGInformation.AddressString
getVlr_number()
Gets the value of the field vlr-number.boolean
hasAgeOfLocationInformation()
Tests whether the field ageOfLocationInformation has a value.boolean
hasCellGlobalIdOrServiceAreaIdOrLAI()
Tests whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value.boolean
hasCurrentLocationRetrieved()
Tests whether the field currentLocationRetrieved is present.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
hasLocationInformationEPS()
Tests whether the field locationInformationEPS has a value.boolean
hasLocationNumber()
Tests whether the field locationNumber has a value.boolean
hasMsc_Number()
Tests whether the field msc-Number has a value.boolean
hasSai_Present()
Tests whether the field sai-Present is present.boolean
hasSelectedLSA_Id()
Tests whether the field selectedLSA-Id has a value.boolean
hasUserCSGInformation()
Tests whether the field userCSGInformation has a value.boolean
hasVlr_number()
Tests whether the field vlr-number has a value.MAPLocationInformation
setAgeOfLocationInformation(int value)
Sets the value of the field ageOfLocationInformation and marks the field as present.MAPLocationInformation
setAgeOfLocationInformationPresent(boolean flag)
Sets the presence or absence of the optional field ageOfLocationInformation.MAPLocationInformation
setCellGlobalIdOrServiceAreaIdOrLAI(MAPCellGlobalIdOrServiceAreaIdOrLAI value)
Sets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.MAPLocationInformation
setCurrentLocationRetrievedPresent(boolean flag)
Sets the presence or absence of the optional field currentLocationRetrieved.MAPLocationInformation
setExtensionContainer(MAPExtensionContainer value)
Sets the value of the field extensionContainer.MAPLocationInformation
setGeodeticInformation(byte[] value)
Sets the value of the field geodeticInformation.MAPLocationInformation
setGeographicalInformation(byte[] value)
Sets the value of the field geographicalInformation.MAPLocationInformation
setLocationInformationEPS(MAPLocationInformationEPS value)
Sets the value of the field locationInformationEPS.MAPLocationInformation
setLocationNumber(LocationNumber value)
Sets the value of the field locationNumber.MAPLocationInformation
setMsc_Number(AddressString value)
Sets the value of the field msc-Number.void
setReadOnly()
Sets this and all its fields to be immutable.MAPLocationInformation
setSai_PresentPresent(boolean flag)
Sets the presence or absence of the optional field sai-Present.MAPLocationInformation
setSelectedLSA_Id(LocalisedServiceAreaId value)
Sets the value of the field selectedLSA-Id.MAPLocationInformation
setUserCSGInformation(MAPUserCSGInformation value)
Sets the value of the field userCSGInformation.MAPLocationInformation
setVlr_number(AddressString value)
Sets the value of the field vlr-number.-
Methods inherited from class com.opencloud.util.AbstractFieldsObject
equals, hashCode, toString
-
Methods inherited from class com.opencloud.util.AbstractDataObject
checkModify, isReadOnly
-
-
-
-
Method Detail
-
clone
public MAPLocationInformation clone()
Constructs a copy of this object and everything reachable from it.- Specified by:
clone
in interfaceDataObject
- Specified by:
clone
in classAbstractDataObject
- Returns:
- copy of object
-
copyOf
public static MAPLocationInformation copyOf(MAPLocationInformation 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:
- MAPLocationInformation
-
getAgeOfLocationInformation
public int getAgeOfLocationInformation()
Gets the value of the field ageOfLocationInformation.- Returns:
- value of field ageOfLocationInformation
-
getCellGlobalIdOrServiceAreaIdOrLAI
public MAPCellGlobalIdOrServiceAreaIdOrLAI getCellGlobalIdOrServiceAreaIdOrLAI()
Gets the value of the field cellGlobalIdOrServiceAreaIdOrLAI.- Returns:
- value of field cellGlobalIdOrServiceAreaIdOrLAI, 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 classAbstractFieldsObject
- 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
-
getLocationInformationEPS
public MAPLocationInformationEPS getLocationInformationEPS()
Gets the value of the field locationInformationEPS.- Returns:
- value of field locationInformationEPS, or null if not present
-
getLocationNumber
public LocationNumber getLocationNumber()
Gets the value of the field locationNumber.- Returns:
- value of field locationNumber, or null if not present
-
getMsc_Number
public AddressString getMsc_Number()
Gets the value of the field msc-Number.- Returns:
- value of field msc-Number, or null if not present
-
getSelectedLSA_Id
public LocalisedServiceAreaId getSelectedLSA_Id()
Gets the value of the field selectedLSA-Id.- Returns:
- value of field selectedLSA-Id, or null if not present
-
getUserCSGInformation
public MAPUserCSGInformation getUserCSGInformation()
Gets the value of the field userCSGInformation.- Returns:
- value of field userCSGInformation, or null if not present
-
getVlr_number
public AddressString getVlr_number()
Gets the value of the field vlr-number.- Returns:
- value of field vlr-number, 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
-
hasCellGlobalIdOrServiceAreaIdOrLAI
public boolean hasCellGlobalIdOrServiceAreaIdOrLAI()
Tests whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value.- Returns:
- whether the field cellGlobalIdOrServiceAreaIdOrLAI has a value
-
hasCurrentLocationRetrieved
public boolean hasCurrentLocationRetrieved()
Tests whether the field currentLocationRetrieved is present.- Returns:
- whether the field currentLocationRetrieved is present
-
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
-
hasLocationInformationEPS
public boolean hasLocationInformationEPS()
Tests whether the field locationInformationEPS has a value.- Returns:
- whether the field locationInformationEPS has a value
-
hasLocationNumber
public boolean hasLocationNumber()
Tests whether the field locationNumber has a value.- Returns:
- whether the field locationNumber has a value
-
hasMsc_Number
public boolean hasMsc_Number()
Tests whether the field msc-Number has a value.- Returns:
- whether the field msc-Number has a value
-
hasSai_Present
public boolean hasSai_Present()
Tests whether the field sai-Present is present.- Returns:
- whether the field sai-Present is present
-
hasSelectedLSA_Id
public boolean hasSelectedLSA_Id()
Tests whether the field selectedLSA-Id has a value.- Returns:
- whether the field selectedLSA-Id has a value
-
hasUserCSGInformation
public boolean hasUserCSGInformation()
Tests whether the field userCSGInformation has a value.- Returns:
- whether the field userCSGInformation has a value
-
hasVlr_number
public boolean hasVlr_number()
Tests whether the field vlr-number has a value.- Returns:
- whether the field vlr-number has a value
-
setAgeOfLocationInformation
public MAPLocationInformation 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 MAPLocationInformation 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
-
setCellGlobalIdOrServiceAreaIdOrLAI
public MAPLocationInformation setCellGlobalIdOrServiceAreaIdOrLAI(MAPCellGlobalIdOrServiceAreaIdOrLAI value) throws IllegalStateException
Sets the value of the field cellGlobalIdOrServiceAreaIdOrLAI. 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
-
setCurrentLocationRetrievedPresent
public MAPLocationInformation 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
-
setExtensionContainer
public MAPLocationInformation 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 MAPLocationInformation 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 MAPLocationInformation 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
-
setLocationInformationEPS
public MAPLocationInformation setLocationInformationEPS(MAPLocationInformationEPS value) throws IllegalStateException
Sets the value of the field locationInformationEPS. 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
-
setLocationNumber
public MAPLocationInformation setLocationNumber(LocationNumber value) throws IllegalStateException
Sets the value of the field locationNumber. 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
-
setMsc_Number
public MAPLocationInformation setMsc_Number(AddressString value) throws IllegalStateException
Sets the value of the field msc-Number. 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 interfaceDataObject
- Overrides:
setReadOnly
in classAbstractDataObject
-
setSai_PresentPresent
public MAPLocationInformation setSai_PresentPresent(boolean flag) throws IllegalStateException
Sets the presence or absence of the optional field sai-Present.- 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
-
setSelectedLSA_Id
public MAPLocationInformation setSelectedLSA_Id(LocalisedServiceAreaId value) throws IllegalStateException
Sets the value of the field selectedLSA-Id. 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
-
setUserCSGInformation
public MAPLocationInformation setUserCSGInformation(MAPUserCSGInformation value) throws IllegalStateException
Sets the value of the field userCSGInformation. 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
-
setVlr_number
public MAPLocationInformation setVlr_number(AddressString value) throws IllegalStateException
Sets the value of the field vlr-number. 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
-
-