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

Class MAPSubscriberLocationReport_Arg

  • All Implemented Interfaces:
    DataObject, Serializable
    public class MAPSubscriberLocationReport_Arg
extends AbstractFieldsObject
    API for MAP-LCS-DataTypes.SubscriberLocationReport-Arg. Generated from the following ASN.1 type definition. 
     SubscriberLocationReport-Arg ::=
     SEQUENCE {
         lcs-Event                    LCS-Event,
         lcs-ClientID                 LCS-ClientID,
         lcsLocationInfo              LCSLocationInfo,
         msisdn                       ISDN-AddressString OPTIONAL,
         imsi                         IMSI OPTIONAL,
         imei                         IMEI OPTIONAL,
         na-ESRD                      ISDN-AddressString OPTIONAL,
         na-ESRK                      ISDN-AddressString OPTIONAL,
         locationEstimate             Ext-GeographicalInformation OPTIONAL,
         ageOfLocationEstimate        AgeOfLocationInformation OPTIONAL,
         slr-ArgExtensionContainer    SLR-ArgExtensionContainer OPTIONAL,  -- Renamed from extensionContainer between R98 and R99.
         ...
         add-LocationEstimate         Add-GeographicalInformation OPTIONAL, -- Added in R99.
         deferredmt-lrData            Deferredmt-lrData OPTIONAL,          -- Added in release 4.
         lcs-ReferenceNumber          LCS-ReferenceNumber 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.
         h-gmlc-Address               GSN-Address OPTIONAL,                -- Added in release 6.
         lcsServiceTypeID             LCSServiceTypeID OPTIONAL,           -- Added in release 6.
         sai-Present                  NULL OPTIONAL,                       -- Added in release 6.
         pseudonymIndicator           NULL OPTIONAL,                       -- Added in release 6.
         accuracyFulfilmentIndicator  AccuracyFulfilmentIndicator OPTIONAL, -- Added in release 6.
         velocityEstimate             VelocityEstimate OPTIONAL,           -- Added in release 7.
         sequenceNumber               SequenceNumber OPTIONAL,             -- Added in release 7.
         periodicLDRInfo              PeriodicLDRInfo 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. One of msisdn or imsi is mandatory. A location estimate that is valid for the locationEstimate parameter should be transferred in this parameter in preference to the add-LocationEstimate. The deferredmt-lrData parameter shall be included if and only if the lcs-Event indicates a deferredmt-lrResponse. If the lcs-Event indicates a deferredmt-lrResponse then the locationEstimate and the add-locationEstimate parameters shall not be sent if the supportedGADShapes parameter had been received in ProvideSubscriberLocation-Arg and the shape encoded in locationEstimate or add-LocationEstimate was not marked as supported in supportedGADShapes. In such a case terminationCause in deferredmt-lrData shall be present with value shapeOfLocationEstimateNotSupported. If a lcs event indicates deferred mt-lr response, the lcs-Reference number shall be included. sai-Present indicates that the cellIdOrSai parameter contains a Service Area Identity.

    Used as argument type by MAPOperations.subscriberLocationReport.

    See Also:
    Serialized Form

    • Constructor Detail

      • MAPSubscriberLocationReport_Arg

        public MAPSubscriberLocationReport_Arg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

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

      • 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

      • getDeferredmt_lrData

        public MAPDeferredmt_lrData getDeferredmt_lrData()
        Gets the value of the field deferredmt-lrData.
        Returns:
        value of field deferredmt-lrData, 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

      • getH_gmlc_Address

        public GSNAddress getH_gmlc_Address()
        Gets the value of the field h-gmlc-Address.
        Returns:
        value of field h-gmlc-Address, or null if not present

      • getImei

        public IMEIAddress getImei()
        Gets the value of the field imei.
        Returns:
        value of field imei, or null if not present

      • getImsi

        public IMSIAddress getImsi()
        Gets the value of the field imsi.
        Returns:
        value of field imsi, or null if not present

      • getLcsLocationInfo

        public MAPLCSLocationInfo getLcsLocationInfo()
        Gets the value of the field lcsLocationInfo.
        Returns:
        value of field lcsLocationInfo, or null if not present

      • getLcsServiceTypeID

        public int getLcsServiceTypeID()
        Gets the value of the field lcsServiceTypeID.
        Returns:
        value of field lcsServiceTypeID

      • getLcs_ClientID

        public MAPLCS_ClientID getLcs_ClientID()
        Gets the value of the field lcs-ClientID.
        Returns:
        value of field lcs-ClientID, or null if not present

      • getLcs_Event

        public MAPLCS_Event getLcs_Event()
        Gets the value of the field lcs-Event.
        Returns:
        value of field lcs-Event, or null if not present

      • getLcs_ReferenceNumber

        public byte[] getLcs_ReferenceNumber()
        Gets the value of the field lcs-ReferenceNumber.
        Returns:
        value of field lcs-ReferenceNumber, 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

      • getMsisdn

        public AddressString getMsisdn()
        Gets the value of the field msisdn.
        Returns:
        value of field msisdn, or null if not present

      • getNa_ESRD

        public AddressString getNa_ESRD()
        Gets the value of the field na-ESRD.
        Returns:
        value of field na-ESRD, or null if not present

      • getNa_ESRK

        public AddressString getNa_ESRK()
        Gets the value of the field na-ESRK.
        Returns:
        value of field na-ESRK, or null if not present

      • getPeriodicLDRInfo

        public MAPPeriodicLDRInfo getPeriodicLDRInfo()
        Gets the value of the field periodicLDRInfo.
        Returns:
        value of field periodicLDRInfo, or null if not present

      • getSequenceNumber

        public int getSequenceNumber()
        Gets the value of the field sequenceNumber.
        Returns:
        value of field sequenceNumber

      • getSlr_ArgExtensionContainer

        public MAPSLR_ArgExtensionContainer getSlr_ArgExtensionContainer()
        Gets the value of the field slr-ArgExtensionContainer.
        Returns:
        value of field slr-ArgExtensionContainer, 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_lrData

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

      • hasH_gmlc_Address

        public boolean hasH_gmlc_Address()
        Tests whether the field h-gmlc-Address has a value.
        Returns:
        whether the field h-gmlc-Address has a value

      • hasImei

        public boolean hasImei()
        Tests whether the field imei has a value.
        Returns:
        whether the field imei has a value

      • hasImsi

        public boolean hasImsi()
        Tests whether the field imsi has a value.
        Returns:
        whether the field imsi has a value

      • hasLcsLocationInfo

        public boolean hasLcsLocationInfo()
        Tests whether the field lcsLocationInfo has a value.
        Returns:
        whether the field lcsLocationInfo has a value

      • hasLcsServiceTypeID

        public boolean hasLcsServiceTypeID()
        Tests whether the field lcsServiceTypeID has a value.
        Returns:
        whether the field lcsServiceTypeID has a value

      • hasLcs_ClientID

        public boolean hasLcs_ClientID()
        Tests whether the field lcs-ClientID has a value.
        Returns:
        whether the field lcs-ClientID has a value

      • hasLcs_Event

        public boolean hasLcs_Event()
        Tests whether the field lcs-Event has a value.
        Returns:
        whether the field lcs-Event has a value

      • hasLcs_ReferenceNumber

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

      • hasMsisdn

        public boolean hasMsisdn()
        Tests whether the field msisdn has a value.
        Returns:
        whether the field msisdn has a value

      • hasNa_ESRD

        public boolean hasNa_ESRD()
        Tests whether the field na-ESRD has a value.
        Returns:
        whether the field na-ESRD has a value

      • hasNa_ESRK

        public boolean hasNa_ESRK()
        Tests whether the field na-ESRK has a value.
        Returns:
        whether the field na-ESRK has a value

      • hasPeriodicLDRInfo

        public boolean hasPeriodicLDRInfo()
        Tests whether the field periodicLDRInfo has a value.
        Returns:
        whether the field periodicLDRInfo has a value

      • hasPseudonymIndicator

        public boolean hasPseudonymIndicator()
        Tests whether the field pseudonymIndicator is present.
        Returns:
        whether the field pseudonymIndicator is present

      • hasSai_Present

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

      • hasSequenceNumber

        public boolean hasSequenceNumber()
        Tests whether the field sequenceNumber has a value.
        Returns:
        whether the field sequenceNumber has a value

      • hasSlr_ArgExtensionContainer

        public boolean hasSlr_ArgExtensionContainer()
        Tests whether the field slr-ArgExtensionContainer has a value.
        Returns:
        whether the field slr-ArgExtensionContainer has a value

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

      • setGeranGANSSpositioningData

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

      • setLcsServiceTypeIDPresent

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

      • setMo_lrShortCircuitIndicatorPresent

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

      • setPseudonymIndicatorPresent

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

      • setSequenceNumberPresent

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