Package com.opencloud.slee.resources.cgin.map

Class MAPLocationInformationGPRS

  • All Implemented Interfaces:
    DataObject, Serializable
    public class MAPLocationInformationGPRS
extends AbstractFieldsObject
    API for MAP-MS-DataTypes.LocationInformationGPRS. Generated from the following ASN.1 type definition. 
     LocationInformationGPRS ::=
     SEQUENCE {
         cellGlobalIdOrServiceAreaIdOrLAI CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL,
         routeingAreaIdentity             RAIdentity OPTIONAL,
         geographicalInformation          GeographicalInformation OPTIONAL,
         sgsn-Number                      ISDN-AddressString OPTIONAL,
         selectedLSAIdentity              LSAIdentity OPTIONAL,
         extensionContainer               ExtensionContainer OPTIONAL,
         ...
         sai-Present                      NULL OPTIONAL,
         geodeticInformation              GeodeticInformation OPTIONAL,
         currentLocationRetrieved         NULL OPTIONAL,
         ageOfLocationInformation         AgeOfLocationInformation OPTIONAL,
         userCSGInformation               UserCSGInformation OPTIONAL          -- Added in release 9.
     }
    Added in release 5. sai-Present indicates that the cellGlobalIdOrServiceAreaIdOrLAI parameter contains a Service Area Identity. currentLocationRetrieved shall be present if the location information was retrieved after successful paging. 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

    • Constructor Detail

      • MAPLocationInformationGPRS

        public MAPLocationInformationGPRS()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

        public static MAPLocationInformationGPRS copyOf​(MAPLocationInformationGPRS 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:
        MAPLocationInformationGPRS

      • 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 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

      • getRouteingAreaIdentity

        public byte[] getRouteingAreaIdentity()
        Gets the value of the field routeingAreaIdentity.
        Returns:
        value of field routeingAreaIdentity, or null if not present

      • getSelectedLSAIdentity

        public LocalisedServiceAreaId getSelectedLSAIdentity()
        Gets the value of the field selectedLSAIdentity.
        Returns:
        value of field selectedLSAIdentity, or null if not present

      • getSgsn_Number

        public AddressString getSgsn_Number()
        Gets the value of the field sgsn-Number.
        Returns:
        value of field sgsn-Number, 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

      • 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

      • hasRouteingAreaIdentity

        public boolean hasRouteingAreaIdentity()
        Tests whether the field routeingAreaIdentity has a value.
        Returns:
        whether the field routeingAreaIdentity 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

      • hasSelectedLSAIdentity

        public boolean hasSelectedLSAIdentity()
        Tests whether the field selectedLSAIdentity has a value.
        Returns:
        whether the field selectedLSAIdentity has a value

      • hasSgsn_Number

        public boolean hasSgsn_Number()
        Tests whether the field sgsn-Number has a value.
        Returns:
        whether the field sgsn-Number has a value

      • hasUserCSGInformation

        public boolean hasUserCSGInformation()
        Tests whether the field userCSGInformation has a value.
        Returns:
        whether the field userCSGInformation has a value

      • setAgeOfLocationInformation

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

      • setGeodeticInformation

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

      • setRouteingAreaIdentity

        public MAPLocationInformationGPRS setRouteingAreaIdentity​(byte[] value)
                                                   throws IllegalStateException
        Sets the value of the field routeingAreaIdentity. 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

      • setSai_PresentPresent

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