Package com.opencloud.slee.resources.cgin.cap_v3

Class CAP3InitialDPSMSArg

  • All Implemented Interfaces:
    DataObject, Serializable
    Direct Known Subclasses:
    CAP4InitialDPSMSArg
    public class CAP3InitialDPSMSArg
extends AbstractFieldsObject
    API for CAP-SMS-ops-args.InitialDPSMSArg. Generated from the following ASN.1 type definition. 
     InitialDPSMSArg ::=
     SEQUENCE {
         serviceKey                   ServiceKey,
         destinationSubscriberNumber  CalledPartyBCDNumber OPTIONAL,
         callingPartyNumber           ISDN-AddressString OPTIONAL,
         eventTypeSMS                 EventTypeSMS OPTIONAL,
         iMSI                         IMSI OPTIONAL,
         locationInformationMSC       LocationInformation OPTIONAL,
         locationInformationGPRS      LocationInformationGPRS OPTIONAL,
         sMSCAddress                  ISDN-AddressString OPTIONAL,
         timeAndTimezone              TimeAndTimezone OPTIONAL,
         tPShortMessageSubmissionInfo TPShortMessageSubmissionInfo OPTIONAL,
         tPProtocolIdentifier         TPProtocolIdentifier OPTIONAL,
         tPDataCodingScheme           TPDataCodingScheme OPTIONAL,
         tPValidityPeriod             TPValidityPeriod OPTIONAL,
         extensions                   Extensions OPTIONAL,
         ...
         smsReferenceNumber           CallReferenceNumber OPTIONAL,
         mscAddress                   ISDN-AddressString OPTIONAL,
         sgsn-Number                  ISDN-AddressString OPTIONAL
     }

    Used as argument type by CAP3Operations.initialDPSMS.

    See Also:
    Serialized Form

    • Constructor Detail

      • CAP3InitialDPSMSArg

        public CAP3InitialDPSMSArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

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

      • getCallingPartyNumber

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

      • getDestinationSubscriberNumber

        public CalledPartyBCDNumber getDestinationSubscriberNumber()
        Gets the value of the field destinationSubscriberNumber.
        Returns:
        value of field destinationSubscriberNumber, or null if not present

      • getEventTypeSMS

        public CAP3EventTypeSMS getEventTypeSMS()
        Gets the value of the field eventTypeSMS.
        Returns:
        value of field eventTypeSMS, or null if not present

      • getExtensions

        public CAP1ExtensionField[] getExtensions()
        Gets the value of the field extensions.
        Returns:
        value of field extensions, 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

      • getIMSI

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

      • getLocationInformationGPRS

        public CAP3LocationInformationGPRS getLocationInformationGPRS()
        Gets the value of the field locationInformationGPRS.
        Returns:
        value of field locationInformationGPRS, or null if not present

      • getLocationInformationMSC

        public MAPLocationInformation getLocationInformationMSC()
        Gets the value of the field locationInformationMSC.
        Returns:
        value of field locationInformationMSC, or null if not present

      • getMscAddress

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

      • getSMSCAddress

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

      • getServiceKey

        public int getServiceKey()
        Gets the value of the field serviceKey.
        Returns:
        value of field serviceKey

      • 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

      • getSmsReferenceNumber

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

      • getTPDataCodingScheme

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

      • getTPProtocolIdentifier

        public SMSProtocolId getTPProtocolIdentifier()
        Gets the value of the field tPProtocolIdentifier.
        Returns:
        value of field tPProtocolIdentifier, or null if not present

      • getTPShortMessageSubmissionInfo

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

      • getTPValidityPeriod

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

      • getTimeAndTimezone

        public TimeAndTimezone getTimeAndTimezone()
        Gets the value of the field timeAndTimezone.
        Returns:
        value of field timeAndTimezone, or null if not present

      • hasCallingPartyNumber

        public boolean hasCallingPartyNumber()
        Tests whether the field callingPartyNumber has a value.
        Returns:
        whether the field callingPartyNumber has a value

      • hasDestinationSubscriberNumber

        public boolean hasDestinationSubscriberNumber()
        Tests whether the field destinationSubscriberNumber has a value.
        Returns:
        whether the field destinationSubscriberNumber has a value

      • hasEventTypeSMS

        public boolean hasEventTypeSMS()
        Tests whether the field eventTypeSMS has a value.
        Returns:
        whether the field eventTypeSMS has a value

      • hasExtensions

        public boolean hasExtensions()
        Tests whether the field extensions has a value.
        Returns:
        whether the field extensions has a value

      • hasIMSI

        public boolean hasIMSI()
        Tests whether the field iMSI has a value.
        Returns:
        whether the field iMSI has a value

      • hasLocationInformationGPRS

        public boolean hasLocationInformationGPRS()
        Tests whether the field locationInformationGPRS has a value.
        Returns:
        whether the field locationInformationGPRS has a value

      • hasLocationInformationMSC

        public boolean hasLocationInformationMSC()
        Tests whether the field locationInformationMSC has a value.
        Returns:
        whether the field locationInformationMSC has a value

      • hasMscAddress

        public boolean hasMscAddress()
        Tests whether the field mscAddress has a value.
        Returns:
        whether the field mscAddress has a value

      • hasSMSCAddress

        public boolean hasSMSCAddress()
        Tests whether the field sMSCAddress has a value.
        Returns:
        whether the field sMSCAddress has a value

      • hasServiceKey

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

      • hasSmsReferenceNumber

        public boolean hasSmsReferenceNumber()
        Tests whether the field smsReferenceNumber has a value.
        Returns:
        whether the field smsReferenceNumber has a value

      • hasTPDataCodingScheme

        public boolean hasTPDataCodingScheme()
        Tests whether the field tPDataCodingScheme has a value.
        Returns:
        whether the field tPDataCodingScheme has a value

      • hasTPProtocolIdentifier

        public boolean hasTPProtocolIdentifier()
        Tests whether the field tPProtocolIdentifier has a value.
        Returns:
        whether the field tPProtocolIdentifier has a value

      • hasTPShortMessageSubmissionInfo

        public boolean hasTPShortMessageSubmissionInfo()
        Tests whether the field tPShortMessageSubmissionInfo has a value.
        Returns:
        whether the field tPShortMessageSubmissionInfo has a value

      • hasTPValidityPeriod

        public boolean hasTPValidityPeriod()
        Tests whether the field tPValidityPeriod has a value.
        Returns:
        whether the field tPValidityPeriod has a value

      • hasTimeAndTimezone

        public boolean hasTimeAndTimezone()
        Tests whether the field timeAndTimezone has a value.
        Returns:
        whether the field timeAndTimezone has a value

      • setServiceKey

        public CAP3InitialDPSMSArg setServiceKey​(int value)
                                  throws IllegalStateException
        Sets the value of the field serviceKey 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

      • setSmsReferenceNumber

        public CAP3InitialDPSMSArg setSmsReferenceNumber​(byte[] value)
                                          throws IllegalStateException
        Sets the value of the field smsReferenceNumber. 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

      • setTPDataCodingScheme

        public CAP3InitialDPSMSArg setTPDataCodingScheme​(byte[] value)
                                          throws IllegalStateException
        Sets the value of the field tPDataCodingScheme. 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

      • setTPShortMessageSubmissionInfo

        public CAP3InitialDPSMSArg setTPShortMessageSubmissionInfo​(byte[] value)
                                                    throws IllegalStateException
        Sets the value of the field tPShortMessageSubmissionInfo. 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

      • setTPValidityPeriod

        public CAP3InitialDPSMSArg setTPValidityPeriod​(byte[] value)
                                        throws IllegalStateException
        Sets the value of the field tPValidityPeriod. 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