Class MAPReportSM_DeliveryStatusArg

  • All Implemented Interfaces:
    DataObject, Serializable

    public class MAPReportSM_DeliveryStatusArg
    extends MAPReportSM_DeliveryStatusArg_v1
    API for MAP-SM-DataTypes.ReportSM-DeliveryStatusArg. Generated from the following ASN.1 type definition and the adaptations below.
     ReportSM-DeliveryStatusArg ::=
         SEQUENCE {
             msisdn                                 ISDN-AddressString,
             serviceCentreAddress                   AddressString,
             sm-DeliveryOutcome                     SM-DeliveryOutcome,
             absentSubscriberDiagnosticSM           AbsentSubscriberDiagnosticSM OPTIONAL, -- Added in R96.
             extensionContainer                     ExtensionContainer OPTIONAL,         -- Added in R96.
             ...
             gprsSupportIndicator                   NULL OPTIONAL,                       -- Added in R97.  gprsSupportIndicator is set only if the SMS-GMSC supports handling of two delivery outcomes.
             deliveryOutcomeIndicator               NULL OPTIONAL,                       -- Added in R97.  DeliveryOutcomeIndicator is set when the SM-DeliveryOutcome is for GPRS.
             additionalSM-DeliveryOutcome           SM-DeliveryOutcome OPTIONAL,         -- Added in R97.  If received, additionalSM-DeliveryOutcome is for GPRS.  If DeliveryOutcomeIndicator is set, then AdditionalSM-DeliveryOutcome shall be absent.
             additionalAbsentSubscriberDiagnosticSM AbsentSubscriberDiagnosticSM OPTIONAL, -- Added in R97.  If received additionalAbsentSubscriberDiagnosticSM is for GPRS.  If DeliveryOutcomeIndicator is set, then AdditionalAbsentSubscriberDiagnosticSM shall be absent.
             ip-sm-gw-Indicator                     NULL OPTIONAL,                       -- Added in release 7.  The ip-sm-gw indicator indicates by its presence that sm-deliveryOutcome is for delivery via IMS.  If present, deliveryOutcomeIndicator shall be absent.
             ip-sm-gw-sm-deliveryOutcome            SM-DeliveryOutcome OPTIONAL,         -- Added in release 7.  If received ip-sm-gw-sm-deliveryOutcome is for delivery via IMS.  If ip-sm-gw-Indicator is set, then ip-sm-gw-sm-deliveryOutcome shall be absent.
             ip-sm-gw-absentSubscriberDiagnosticSM  AbsentSubscriberDiagnosticSM OPTIONAL -- Added in release 7.  If received ip-sm-gw-sm-absentSubscriberDiagnosticSM is for delivery via IMS.  If ip-sm-gw-Indicator is set, then ip-sm-gw-sm-absentSubscriberDiagnosticSM shall be absent.
         }
     MAP-SM-DataTypes {
         ReportSM-DeliveryStatusArg {
             @parentASN1Type MAP-SM-DataTypes-ph1.ReportSM-DeliveryStatusArg-v1
         }
     }
     
    Added in ph2.

    Used as argument type by MAPOperations.reportSM_DeliveryStatus.

    Used as argument type by MAPOperations.reportSM_DeliveryStatus_v3.

    See Also:
    Serialized Form
    • Constructor Detail

      • MAPReportSM_DeliveryStatusArg

        public MAPReportSM_DeliveryStatusArg()
        Constructs an object with uninitialised state.
    • Method Detail

      • copyOf

        public static MAPReportSM_DeliveryStatusArg copyOf​(MAPReportSM_DeliveryStatusArg_v1 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:
        MAPReportSM_DeliveryStatusArg
      • getAbsentSubscriberDiagnosticSM

        public int getAbsentSubscriberDiagnosticSM()
        Gets the value of the field absentSubscriberDiagnosticSM.
        Returns:
        value of field absentSubscriberDiagnosticSM
      • getAdditionalAbsentSubscriberDiagnosticSM

        public int getAdditionalAbsentSubscriberDiagnosticSM()
        Gets the value of the field additionalAbsentSubscriberDiagnosticSM.
        Returns:
        value of field additionalAbsentSubscriberDiagnosticSM
      • getAdditionalSM_DeliveryOutcome

        public MAPSM_DeliveryOutcome getAdditionalSM_DeliveryOutcome()
        Gets the value of the field additionalSM-DeliveryOutcome.
        Returns:
        value of field additionalSM-DeliveryOutcome, 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.
        Overrides:
        getFieldsMap in class MAPReportSM_DeliveryStatusArg_v1
        Parameters:
        withAbsents - whether to put absent optional fields into Map
        Returns:
        Map from field-name to field-value
      • getIp_sm_gw_absentSubscriberDiagnosticSM

        public int getIp_sm_gw_absentSubscriberDiagnosticSM()
        Gets the value of the field ip-sm-gw-absentSubscriberDiagnosticSM.
        Returns:
        value of field ip-sm-gw-absentSubscriberDiagnosticSM
      • getIp_sm_gw_sm_deliveryOutcome

        public MAPSM_DeliveryOutcome getIp_sm_gw_sm_deliveryOutcome()
        Gets the value of the field ip-sm-gw-sm-deliveryOutcome.
        Returns:
        value of field ip-sm-gw-sm-deliveryOutcome, 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
      • getSm_DeliveryOutcome

        public MAPSM_DeliveryOutcome getSm_DeliveryOutcome()
        Gets the value of the field sm-DeliveryOutcome.
        Returns:
        value of field sm-DeliveryOutcome, or null if not present
      • hasAbsentSubscriberDiagnosticSM

        public boolean hasAbsentSubscriberDiagnosticSM()
        Tests whether the field absentSubscriberDiagnosticSM has a value.
        Returns:
        whether the field absentSubscriberDiagnosticSM has a value
      • hasAdditionalAbsentSubscriberDiagnosticSM

        public boolean hasAdditionalAbsentSubscriberDiagnosticSM()
        Tests whether the field additionalAbsentSubscriberDiagnosticSM has a value.
        Returns:
        whether the field additionalAbsentSubscriberDiagnosticSM has a value
      • hasAdditionalSM_DeliveryOutcome

        public boolean hasAdditionalSM_DeliveryOutcome()
        Tests whether the field additionalSM-DeliveryOutcome has a value.
        Returns:
        whether the field additionalSM-DeliveryOutcome has a value
      • hasDeliveryOutcomeIndicator

        public boolean hasDeliveryOutcomeIndicator()
        Tests whether the field deliveryOutcomeIndicator is present.
        Returns:
        whether the field deliveryOutcomeIndicator is present
      • hasExtensionContainer

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

        public boolean hasGprsSupportIndicator()
        Tests whether the field gprsSupportIndicator is present.
        Returns:
        whether the field gprsSupportIndicator is present
      • hasIp_sm_gw_Indicator

        public boolean hasIp_sm_gw_Indicator()
        Tests whether the field ip-sm-gw-Indicator is present.
        Returns:
        whether the field ip-sm-gw-Indicator is present
      • hasIp_sm_gw_absentSubscriberDiagnosticSM

        public boolean hasIp_sm_gw_absentSubscriberDiagnosticSM()
        Tests whether the field ip-sm-gw-absentSubscriberDiagnosticSM has a value.
        Returns:
        whether the field ip-sm-gw-absentSubscriberDiagnosticSM has a value
      • hasIp_sm_gw_sm_deliveryOutcome

        public boolean hasIp_sm_gw_sm_deliveryOutcome()
        Tests whether the field ip-sm-gw-sm-deliveryOutcome has a value.
        Returns:
        whether the field ip-sm-gw-sm-deliveryOutcome has a value
      • hasMsisdn

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

        public boolean hasSm_DeliveryOutcome()
        Tests whether the field sm-DeliveryOutcome has a value.
        Returns:
        whether the field sm-DeliveryOutcome has a value
      • setAbsentSubscriberDiagnosticSM

        public MAPReportSM_DeliveryStatusArg setAbsentSubscriberDiagnosticSM​(int value)
                                                                      throws IllegalStateException
        Sets the value of the field absentSubscriberDiagnosticSM 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
      • setAbsentSubscriberDiagnosticSMPresent

        public MAPReportSM_DeliveryStatusArg setAbsentSubscriberDiagnosticSMPresent​(boolean flag)
                                                                             throws IllegalStateException
        Sets the presence or absence of the optional field absentSubscriberDiagnosticSM.
        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
      • setAdditionalAbsentSubscriberDiagnosticSM

        public MAPReportSM_DeliveryStatusArg setAdditionalAbsentSubscriberDiagnosticSM​(int value)
                                                                                throws IllegalStateException
        Sets the value of the field additionalAbsentSubscriberDiagnosticSM 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
      • setAdditionalAbsentSubscriberDiagnosticSMPresent

        public MAPReportSM_DeliveryStatusArg setAdditionalAbsentSubscriberDiagnosticSMPresent​(boolean flag)
                                                                                       throws IllegalStateException
        Sets the presence or absence of the optional field additionalAbsentSubscriberDiagnosticSM.
        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
      • setDeliveryOutcomeIndicatorPresent

        public MAPReportSM_DeliveryStatusArg setDeliveryOutcomeIndicatorPresent​(boolean flag)
                                                                         throws IllegalStateException
        Sets the presence or absence of the optional field deliveryOutcomeIndicator.
        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
      • setGprsSupportIndicatorPresent

        public MAPReportSM_DeliveryStatusArg setGprsSupportIndicatorPresent​(boolean flag)
                                                                     throws IllegalStateException
        Sets the presence or absence of the optional field gprsSupportIndicator.
        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
      • setIp_sm_gw_IndicatorPresent

        public MAPReportSM_DeliveryStatusArg setIp_sm_gw_IndicatorPresent​(boolean flag)
                                                                   throws IllegalStateException
        Sets the presence or absence of the optional field ip-sm-gw-Indicator.
        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
      • setIp_sm_gw_absentSubscriberDiagnosticSM

        public MAPReportSM_DeliveryStatusArg setIp_sm_gw_absentSubscriberDiagnosticSM​(int value)
                                                                               throws IllegalStateException
        Sets the value of the field ip-sm-gw-absentSubscriberDiagnosticSM 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
      • setIp_sm_gw_absentSubscriberDiagnosticSMPresent

        public MAPReportSM_DeliveryStatusArg setIp_sm_gw_absentSubscriberDiagnosticSMPresent​(boolean flag)
                                                                                      throws IllegalStateException
        Sets the presence or absence of the optional field ip-sm-gw-absentSubscriberDiagnosticSM.
        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