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

Class MAPProvideSubscriberLocation_Res

  • All Implemented Interfaces:
    DataObject, Serializable
    public class MAPProvideSubscriberLocation_Res
extends AbstractFieldsObject
    API for MAP-LCS-DataTypes.ProvideSubscriberLocation-Res. Generated from the following ASN.1 type definition. 
     ProvideSubscriberLocation-Res ::=
     SEQUENCE {
         locationEstimate               Ext-GeographicalInformation,
         ageOfLocationEstimate          AgeOfLocationInformation OPTIONAL,
         extensionContainer             ExtensionContainer OPTIONAL,
         ...
         add-LocationEstimate           Add-GeographicalInformation OPTIONAL,
         deferredmt-lrResponseIndicator NULL OPTIONAL,                       -- Added in release 4.
         geranPositioningData           PositioningDataInformation OPTIONAL, -- Added in release 5.
         utranPositioningData           UtranPositioningDataInfo OPTIONAL,   -- Added in release 5.
         cellIdOrSai                    CellGlobalIdOrServiceAreaIdOrLAI OPTIONAL, -- Added in release 6.
         sai-Present                    NULL OPTIONAL,                       -- Added in release 6.
         accuracyFulfilmentIndicator    AccuracyFulfilmentIndicator OPTIONAL, -- Added in release 6.
         velocityEstimate               VelocityEstimate OPTIONAL,           -- Added in release 7.
         mo-lrShortCircuitIndicator     NULL OPTIONAL,                       -- Added in release 7.
         geranGANSSpositioningData      GeranGANSSpositioningData OPTIONAL,  -- Added in release 7.  Deleted in release 8.  Added in release 9.
         utranGANSSpositioningData      UtranGANSSpositioningData OPTIONAL,  -- Added in release 7.  Deleted in release 8.  Added in release 9.
         targetServingNodeForHandover   ServingNodeAddress OPTIONAL          -- Added in release 9.
     }
    Added in R98. If deferredmt-lrResponseIndicator is set, locationEstimate is ignored. The add-LocationEstimate parameter shall not be sent to a node that did not indicate the geographic shapes supported in the ProvideSubscriberLocation-Arg. The locationEstimate and the add-locationEstimate parameters shall not be sent if the supportedGADShapes parameter has been received in ProvideSubscriberLocation-Arg and the shape encoded in locationEstimate or add-LocationEstimate is not marked as supported in supportedGADShapes. In such a case ProvideSubscriberLocation shall be rejected with error FacilityNotSupported with additional indication shapeOfLocationEstimateNotSupported. sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity.

    Used as result type by MAPOperations.provideSubscriberLocation.

    See Also:
    Serialized Form

    • Constructor Detail

      • MAPProvideSubscriberLocation_Res

        public MAPProvideSubscriberLocation_Res()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

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

      • getAccuracyFulfilmentIndicator

        public MAPAccuracyFulfilmentIndicator getAccuracyFulfilmentIndicator()
        Gets the value of the field accuracyFulfilmentIndicator.
        Returns:
        value of field accuracyFulfilmentIndicator, or null if not present

      • getAdd_LocationEstimate

        public byte[] getAdd_LocationEstimate()
        Gets the value of the field add-LocationEstimate.
        Returns:
        value of field add-LocationEstimate, or null if not present

      • getAgeOfLocationEstimate

        public int getAgeOfLocationEstimate()
        Gets the value of the field ageOfLocationEstimate.
        Returns:
        value of field ageOfLocationEstimate

      • getCellIdOrSai

        public MAPCellGlobalIdOrServiceAreaIdOrLAI getCellIdOrSai()
        Gets the value of the field cellIdOrSai.
        Returns:
        value of field cellIdOrSai, 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

      • getGeranGANSSpositioningData

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

      • getGeranPositioningData

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

      • getLocationEstimate

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

      • getTargetServingNodeForHandover

        public MAPServingNodeAddress getTargetServingNodeForHandover()
        Gets the value of the field targetServingNodeForHandover.
        Returns:
        value of field targetServingNodeForHandover, or null if not present

      • getUtranGANSSpositioningData

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

      • getUtranPositioningData

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

      • getVelocityEstimate

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

      • hasAccuracyFulfilmentIndicator

        public boolean hasAccuracyFulfilmentIndicator()
        Tests whether the field accuracyFulfilmentIndicator has a value.
        Returns:
        whether the field accuracyFulfilmentIndicator has a value

      • hasAdd_LocationEstimate

        public boolean hasAdd_LocationEstimate()
        Tests whether the field add-LocationEstimate has a value.
        Returns:
        whether the field add-LocationEstimate has a value

      • hasAgeOfLocationEstimate

        public boolean hasAgeOfLocationEstimate()
        Tests whether the field ageOfLocationEstimate has a value.
        Returns:
        whether the field ageOfLocationEstimate has a value

      • hasCellIdOrSai

        public boolean hasCellIdOrSai()
        Tests whether the field cellIdOrSai has a value.
        Returns:
        whether the field cellIdOrSai has a value

      • hasDeferredmt_lrResponseIndicator

        public boolean hasDeferredmt_lrResponseIndicator()
        Tests whether the field deferredmt-lrResponseIndicator is present.
        Returns:
        whether the field deferredmt-lrResponseIndicator is present

      • hasExtensionContainer

        public boolean hasExtensionContainer()
        Tests whether the field extensionContainer has a value.
        Returns:
        whether the field extensionContainer has a value

      • hasGeranGANSSpositioningData

        public boolean hasGeranGANSSpositioningData()
        Tests whether the field geranGANSSpositioningData has a value.
        Returns:
        whether the field geranGANSSpositioningData has a value

      • hasGeranPositioningData

        public boolean hasGeranPositioningData()
        Tests whether the field geranPositioningData has a value.
        Returns:
        whether the field geranPositioningData has a value

      • hasLocationEstimate

        public boolean hasLocationEstimate()
        Tests whether the field locationEstimate has a value.
        Returns:
        whether the field locationEstimate has a value

      • hasMo_lrShortCircuitIndicator

        public boolean hasMo_lrShortCircuitIndicator()
        Tests whether the field mo-lrShortCircuitIndicator is present.
        Returns:
        whether the field mo-lrShortCircuitIndicator is present

      • hasSai_Present

        public boolean hasSai_Present()
        Tests whether the field sai-Present is present.
        Returns:
        whether the field sai-Present is present

      • hasTargetServingNodeForHandover

        public boolean hasTargetServingNodeForHandover()
        Tests whether the field targetServingNodeForHandover has a value.
        Returns:
        whether the field targetServingNodeForHandover has a value

      • hasUtranGANSSpositioningData

        public boolean hasUtranGANSSpositioningData()
        Tests whether the field utranGANSSpositioningData has a value.
        Returns:
        whether the field utranGANSSpositioningData has a value

      • hasUtranPositioningData

        public boolean hasUtranPositioningData()
        Tests whether the field utranPositioningData has a value.
        Returns:
        whether the field utranPositioningData has a value

      • hasVelocityEstimate

        public boolean hasVelocityEstimate()
        Tests whether the field velocityEstimate has a value.
        Returns:
        whether the field velocityEstimate has a value

      • setAgeOfLocationEstimatePresent

        public MAPProvideSubscriberLocation_Res setAgeOfLocationEstimatePresent​(boolean flag)
                                                                 throws IllegalStateException
        Sets the presence or absence of the optional field ageOfLocationEstimate.
        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

      • setDeferredmt_lrResponseIndicatorPresent

        public MAPProvideSubscriberLocation_Res setDeferredmt_lrResponseIndicatorPresent​(boolean flag)
                                                                          throws IllegalStateException
        Sets the presence or absence of the optional field deferredmt-lrResponseIndicator.
        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

      • setGeranGANSSpositioningData

        public MAPProvideSubscriberLocation_Res setGeranGANSSpositioningData​(byte[] value)
                                                              throws IllegalStateException
        Sets the value of the field geranGANSSpositioningData. 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

      • setMo_lrShortCircuitIndicatorPresent

        public MAPProvideSubscriberLocation_Res setMo_lrShortCircuitIndicatorPresent​(boolean flag)
                                                                      throws IllegalStateException
        Sets the presence or absence of the optional field mo-lrShortCircuitIndicator.
        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

      • setSai_PresentPresent

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

      • setUtranGANSSpositioningData

        public MAPProvideSubscriberLocation_Res setUtranGANSSpositioningData​(byte[] value)
                                                              throws IllegalStateException
        Sets the value of the field utranGANSSpositioningData. 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