Class ReportingReason

  • All Implemented Interfaces:
    Serializable, Enumerated

    public class ReportingReason
    extends Object
    implements Serializable, Enumerated
    Java class to represent the ReportingReason enumerated type.

    Documentation from the relevant specification:

    The Reporting-Reason AVP (AVP code 872) is of type Enumerated and specifies the reason for usage reporting for one or more types of quota for a particular category. It can occur directly in the Multiple-Services-Credit- Control AVP, or in the Used-Service-Units AVP within a Credit Control Request command reporting credit usage. It shall not be used at command level. It shall always and shall only be sent when usage is being reported. The values QHT, FINAL, VALIDITY_TIME, FORCED_REAUTHORISATION, RATING_CONDITION_CHANGE apply for all quota types and are used directly in the Multiple-Services-Credit-Control AVP, whereas the values THRESHOLD, QUOTA_EXHAUSTED and OTHER_QUOTA_TYPE apply to one particular quota type and shall occur only in the Used-Service-Units AVP. The value POOL_EXHAUSTED apply to all quota types using the credit pool and occurs in the Used- Service-Units AVP. It may optionally occur in the Multiple-Services-Credit- Control AVP if all quota types use the same pool. When the value RATING_CONDITION_CHANGE is used, the Trigger-Type AVP shall also be included to indicate the specific event which caused the re- authorisation request.

    Author:
    Open Cloud
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int _FINAL  
      static int _FORCED_REAUTHORISATION  
      static int _OTHER_QUOTA_TYPE  
      static int _POOL_EXHAUSTED  
      static int _QHT  
      static int _QUOTA_EXHAUSTED  
      static int _RATING_CONDITION_CHANGE  
      static int _THRESHOLD  
      static int _VALIDITY_TIME  
      static ReportingReason FINAL
      This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that a normal PDP context termination has happened.
      static ReportingReason FORCED_REAUTHORISATION
      This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that it is there has been a Server initiated re- authorisation procedure, i.e.
      static ReportingReason OTHER_QUOTA_TYPE
      This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that, for a multi-dimensional quota, one reached a trigger condition and the other quota is being reported.
      static ReportingReason POOL_EXHAUSTED
      This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the User-Service-Units AVP where it appears is that granted units are still available in the pool but are not sufficient for a rating group using the pool.
      static ReportingReason QHT
      This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that the quota holding time specified in a previous CCA command has been hit (i.e.
      static ReportingReason QUOTA_EXHAUSTED
      This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that the quota has been exhausted.
      static ReportingReason RATING_CONDITION_CHANGE
      This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that a change has happened in some of the rating conditions that were previously armed (through the Trigger-Type AVP, e.g.
      static ReportingReason THRESHOLD
      This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that the threshold has been reached.
      static ReportingReason VALIDITY_TIME
      This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that the credit authorization lifetime provided in the Validity-Time AVP has expired.
    • Field Detail

      • _RATING_CONDITION_CHANGE

        public static final int _RATING_CONDITION_CHANGE
        See Also:
        Constant Field Values
      • _FORCED_REAUTHORISATION

        public static final int _FORCED_REAUTHORISATION
        See Also:
        Constant Field Values
      • THRESHOLD

        public static final ReportingReason THRESHOLD
        This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that the threshold has been reached.
      • QHT

        public static final ReportingReason QHT
        This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that the quota holding time specified in a previous CCA command has been hit (i.e. the quota has been unused for that period of time).
      • FINAL

        public static final ReportingReason FINAL
        This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that a normal PDP context termination has happened.
      • QUOTA_EXHAUSTED

        public static final ReportingReason QUOTA_EXHAUSTED
        This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that the quota has been exhausted.
      • VALIDITY_TIME

        public static final ReportingReason VALIDITY_TIME
        This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that the credit authorization lifetime provided in the Validity-Time AVP has expired.
      • OTHER_QUOTA_TYPE

        public static final ReportingReason OTHER_QUOTA_TYPE
        This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the Used-Service-Units AVP where it appears is that, for a multi-dimensional quota, one reached a trigger condition and the other quota is being reported.
      • RATING_CONDITION_CHANGE

        public static final ReportingReason RATING_CONDITION_CHANGE
        This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that a change has happened in some of the rating conditions that were previously armed (through the Trigger-Type AVP, e.g. QoS, Radio Access Technology, ). The specific condition that has changed is indicated in an associated Trigger-Type AVP.
      • FORCED_REAUTHORISATION

        public static final ReportingReason FORCED_REAUTHORISATION
        This value is used to indicate that the reason for usage reporting of all quota types of the Multiple-Service-Credit-Control AVP where its appears is that it is there has been a Server initiated re- authorisation procedure, i.e. receipt of RAR command
      • POOL_EXHAUSTED

        public static final ReportingReason POOL_EXHAUSTED
        This value is used to indicate that the reason for usage reporting of the particular quota type indicated in the User-Service-Units AVP where it appears is that granted units are still available in the pool but are not sufficient for a rating group using the pool.
    • Method Detail

      • getValue

        public int getValue()
        Description copied from interface: Enumerated
        Return the value of this instance of this enumerated type.
        Specified by:
        getValue in interface Enumerated
        Returns:
        value