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

Class CAP3InitialDPGPRSArg

  • All Implemented Interfaces:
    DataObject, Serializable
    public class CAP3InitialDPGPRSArg
extends AbstractFieldsObject
    API for CAP-gprsSSF-gsmSCF-ops-args.InitialDPGPRSArg. Generated from the following ASN.1 type definition. 
     InitialDPGPRSArg ::=
     SEQUENCE {
         serviceKey              ServiceKey,
         gPRSEventType           GPRSEventType,
         mSISDN                  ISDN-AddressString,
         iMSI                    IMSI,
         timeAndTimeZone         TimeAndTimezone,
         gPRSMSClass             GPRSMSClass OPTIONAL,
         endUserAddress          EndUserAddress OPTIONAL,
         qualityOfService        QualityOfService OPTIONAL,
         accessPointName         AccessPointName OPTIONAL,
         routeingAreaIdentity    RAIdentity OPTIONAL,
         chargingID              GPRSChargingID OPTIONAL,
         sGSNCapabilities        SGSNCapabilities OPTIONAL,
         locationInformationGPRS LocationInformationGPRS OPTIONAL,
         pDPInitiationType       PDPInitiationType OPTIONAL,
         extensions              Extensions OPTIONAL,
         ...
         gGSNAddress             GSN-Address OPTIONAL,
         secondaryPDP-context    NULL OPTIONAL
     }

    Used as argument type by CAP3Operations.initialDPGPRS.

    See Also:
    Serialized Form

    • Constructor Detail

      • CAP3InitialDPGPRSArg

        public CAP3InitialDPGPRSArg()
        Constructs an object with uninitialised state.

    • Method Detail

      • copyOf

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

      • getAccessPointName

        public AccessPointName getAccessPointName()
        Gets the value of the field accessPointName.
        Returns:
        value of field accessPointName, or null if not present

      • getChargingID

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

      • getEndUserAddress

        public CAP3EndUserAddress getEndUserAddress()
        Gets the value of the field endUserAddress.
        Returns:
        value of field endUserAddress, 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

      • getGGSNAddress

        public GSNAddress getGGSNAddress()
        Gets the value of the field gGSNAddress.
        Returns:
        value of field gGSNAddress, or null if not present

      • getGPRSEventType

        public CAP3GPRSEventType getGPRSEventType()
        Gets the value of the field gPRSEventType.
        Returns:
        value of field gPRSEventType, or null if not present

      • getGPRSMSClass

        public CAP3GPRSMSClass getGPRSMSClass()
        Gets the value of the field gPRSMSClass.
        Returns:
        value of field gPRSMSClass, 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

      • getLocationInformationGPRS

        public CAP3LocationInformationGPRS getLocationInformationGPRS()
        Gets the value of the field locationInformationGPRS.
        Returns:
        value of field locationInformationGPRS, 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

      • getPDPInitiationType

        public CAP3PDPInitiationType getPDPInitiationType()
        Gets the value of the field pDPInitiationType.
        Returns:
        value of field pDPInitiationType, or null if not present

      • getQualityOfService

        public CAP3QualityOfService getQualityOfService()
        Gets the value of the field qualityOfService.
        Returns:
        value of field qualityOfService, 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

      • getSGSNCapabilities

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

      • getServiceKey

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

      • getTimeAndTimeZone

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

      • hasAccessPointName

        public boolean hasAccessPointName()
        Tests whether the field accessPointName has a value.
        Returns:
        whether the field accessPointName has a value

      • hasChargingID

        public boolean hasChargingID()
        Tests whether the field chargingID has a value.
        Returns:
        whether the field chargingID has a value

      • hasEndUserAddress

        public boolean hasEndUserAddress()
        Tests whether the field endUserAddress has a value.
        Returns:
        whether the field endUserAddress has a value

      • hasExtensions

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

      • hasGGSNAddress

        public boolean hasGGSNAddress()
        Tests whether the field gGSNAddress has a value.
        Returns:
        whether the field gGSNAddress has a value

      • hasGPRSEventType

        public boolean hasGPRSEventType()
        Tests whether the field gPRSEventType has a value.
        Returns:
        whether the field gPRSEventType has a value

      • hasGPRSMSClass

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

      • hasMSISDN

        public boolean hasMSISDN()
        Tests whether the field mSISDN has a value.
        Returns:
        whether the field mSISDN has a value

      • hasPDPInitiationType

        public boolean hasPDPInitiationType()
        Tests whether the field pDPInitiationType has a value.
        Returns:
        whether the field pDPInitiationType has a value

      • hasQualityOfService

        public boolean hasQualityOfService()
        Tests whether the field qualityOfService has a value.
        Returns:
        whether the field qualityOfService has a value

      • hasRouteingAreaIdentity

        public boolean hasRouteingAreaIdentity()
        Tests whether the field routeingAreaIdentity has a value.
        Returns:
        whether the field routeingAreaIdentity has a value

      • hasSGSNCapabilities

        public boolean hasSGSNCapabilities()
        Tests whether the field sGSNCapabilities has a value.
        Returns:
        whether the field sGSNCapabilities has a value

      • hasSecondaryPDP_context

        public boolean hasSecondaryPDP_context()
        Tests whether the field secondaryPDP-context is present.
        Returns:
        whether the field secondaryPDP-context is present

      • hasServiceKey

        public boolean hasServiceKey()
        Tests whether the field serviceKey has a value.
        Returns:
        whether the field serviceKey has a value

      • hasTimeAndTimeZone

        public boolean hasTimeAndTimeZone()
        Tests whether the field timeAndTimeZone has a value.
        Returns:
        whether the field timeAndTimeZone has a value

      • setChargingID

        public CAP3InitialDPGPRSArg setChargingID​(byte[] value)
                                   throws IllegalStateException
        Sets the value of the field chargingID. 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 CAP3InitialDPGPRSArg 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

      • setSGSNCapabilities

        public CAP3InitialDPGPRSArg setSGSNCapabilities​(byte[] value)
                                         throws IllegalStateException
        Sets the value of the field sGSNCapabilities. 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

      • setSecondaryPDP_contextPresent

        public CAP3InitialDPGPRSArg setSecondaryPDP_contextPresent​(boolean flag)
                                                    throws IllegalStateException
        Sets the presence or absence of the optional field secondaryPDP-context.
        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

      • setServiceKey

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