Interface OnlineUsageResponse

All Superinterfaces:
Response<Usage>, Serializable, UsageResponse, WithExtendedFields

public interface OnlineUsageResponse extends UsageResponse, WithExtendedFields
Interface for the basic online usage response
  • Method Details

    • getCorrelationIdentifier

      String getCorrelationIdentifier()
      Returns:
      the correlation identifier for the request
    • getAdviceOfPriceImpacts

      Collection<CostInformation> getAdviceOfPriceImpacts()
      Returns:
      Collection of Advice of Price Balance Impacts
    • getAdviceOfChargeImpacts

      Collection<Charges> getAdviceOfChargeImpacts()
      Returns:
      Collection of AdviceOfCharge balance impacts
    • getGrantedUnits

      GrantedUnit getGrantedUnits()
      Returns:
      The Granted units
    • getValidityTime

      Long getValidityTime()
      Returns:
      the validity time
    • getQuotaHoldingTime

      UnitValue getQuotaHoldingTime()
      Returns:
      the quota holding time. Unit could be any valid representation of Duration eg. Seconds, Minutes etc
    • getVolumeQuotaThreshold

      UnitValue getVolumeQuotaThreshold()
      Returns:
      the volume quota threshold
    • getCreditThresholdBreaches

      Map<String,CreditThresholdBreaches> getCreditThresholdBreaches()
      This method can be used to get information on credit threshold breaches
    • Credit threshold breaches will be populated in response only if notification mode is configured as PIGGYBACK or ASYNC_PIGGYBACK
    • Returns:
      Map of creditThresholdBreaches with balance element code as key
    • getAllRemainingBalances

      Collection<RemainingBalanceContainer> getAllRemainingBalances()
      Returns:
      Collection of RemainingBalanceContainer that contains the remaining balances information
    • getRedirectionInformation

      RedirectionInformation getRedirectionInformation()
      Method to get the redirection Information from the response
      Returns:
      Redirection Information
    • getQuantityInfo

      Map<String,UnitValue> getQuantityInfo()
      Returns:
      quantity info
    • getQuotaAttribute

      UnitValue getQuotaAttribute(String name)
      Returns:
      a quota related attribute eg. VOLUME_QUOTA_THRESHOLD, QUOTA_HOLDING_TIME etc
    • getAllQuotaAttributes

      Map<String,UnitValue> getAllQuotaAttributes()
      Method that returns a map of all the attributes related to the quota eg.VOLUME_QUOTA_THRESHOLD, QUOTA_HOLDING_TIME
      Returns: