Package oracle.communication.brm.charging.extensions.client

Interface ExtensionRatingPeriod

All Superinterfaces:
BaseRatingPeriod
public interface ExtensionRatingPeriod extends BaseRatingPeriod
Expose rating period API to be accessed in customization
Since:
11.2.0.0

  • Method Details

    • isNewlyAddedExtRatingPeriod

      boolean isNewlyAddedExtRatingPeriod()
      Returns true if it is a newly added rating period
      Returns:
      {true} if it is a newly added rating period

    • isDeletedExtRatingPeriod

      boolean isDeletedExtRatingPeriod()
      Returns true if it is a deleted rating period
      Returns:
      {true} if it is a deleted rating period

    • getOrigZoneTag

      @Deprecated String getOrigZoneTag()
      Deprecated.
      Return the value for the original zone tag
      Returns:
      tag value

    • isFirstUsageGrant

      boolean isFirstUsageGrant()
      {true}, if this extension rating period is a first usage grant
      Returns:
      {true}, if this extension rating period is a first usage grant

    • modifyImpact

      void modifyImpact(UnitValue modifiedImpact)
      Modifies the balance impact amount
      Parameters:
      modifiedImpact - - impact to be modified

    • modifyBalanceElement

      void modifyBalanceElement(Integer balanceElementId)
      Modifies the balance element id and code
      Parameters:
      balanceElementId - - ISO balance element Id

    • modifyBalanceElementCode

      void modifyBalanceElementCode(String beCode)
      Change the balance element code associated with the balance element Id set Set the balance element code corresponding to the balance element code set. Use this method in extensions only if the balance element id is not present in the balance element repository. If it is present, but the balance element code does not correspond to the balance element id, the extensions framework corrects it.
      Parameters:
      beCode -

    • modifyGeneralLedgerCode

      void modifyGeneralLedgerCode(String glCode)
      Modifies the the general ledger code for BalanceElement impacted by this RatingPeriod
      Parameters:
      glCode - - the general ledger code

    • enrichImpactCategory

      void enrichImpactCategory(String enrichedImpactCategory)
      Sets the enriched impact category. The value set here is not going to influence any rating/charging decisions
      Parameters:
      enrichedImpactCategory - - to be set enriched impact category

    • modifyTaxCode

      void modifyTaxCode(String taxCode)
      Modifies the tax Code for associated with the RatingPeriod
      Parameters:
      taxCode - - the tax Code

    • modifyItemType

      void modifyItemType(String itemType)
      Modifies the item Type associated with the RatingPeriod
      Parameters:
      itemType - - the item Type

    • modifyTaxJurisdiction

      void modifyTaxJurisdiction(BigDecimal taxAmount, BigDecimal taxExempt, BigDecimal amountForTaxation, BigDecimal amountTaxed, String name, BigDecimal taxPercent, int type, String jurisdictionLevel, String jurisdictionList)
      Modify the tax jurisdiction details
      Parameters:
      taxAmount -
      taxExempt -
      amountForTaxation -
      amountTaxed -
      name -
      taxPercent -
      type -
      jurisdictionLevel -
      jurisdictionList -

    • modifyRateTag

      void modifyRateTag(String rateTag)
      Modifies the rate tag associated with the RatingPeriod
      Parameters:
      rateTag - - the rate tag

    • modifyLineage

      void modifyLineage(String lineage)
      Modifies the lineage associated with the RatingPeriod
      Parameters:
      lineage - - the lineage

    • modifyDiscountInfo

      void modifyDiscountInfo(String discountInfo)
      Modifies the discount information associated with the RatingPeriod
      Parameters:
      discountInfo - - the discount information

    • markForDeletion

      void markForDeletion()
      Marks the rating period for deletion

    • getOfferProfile

      oracle.communication.brm.charging.config.offerprofile.OfferProfile getOfferProfile()
      The OfferProfile which created/is associated with this RatingPeriod
      Returns:

    • getTaxRate

      BigDecimal getTaxRate()
      Overridden tax rate
      Returns:
      The overridden tax rate

    • setTaxRate

      void setTaxRate(BigDecimal taxRate)
      modifies the tax packet with new tax code information
      Parameters:
      taxRate - the tax rate

    • getTimeRange

      Range getTimeRange()
      Overridden time range
      Returns:
      The overridden time range

    • getRecurringBundleDetails

      oracle.communication.brm.charging.util.misc.Pair<Integer,Long> getRecurringBundleDetails()
      Overridden recurring bundle information
      Returns:
      The overridden recurring bundle information

    • getSource

      ExtensionRatingPeriod.Source getSource()
      Whether this was created by externally in extension or by ECE internally (and modified)
      Returns:

    • getActualQty

      oracle.communication.brm.charging.util.range.QuantityRange getActualQty()
      Get The actualQuatity of the RP
      Returns:

    • isAdjustedForWorstCost

      boolean isAdjustedForWorstCost()

    • isConsumedRatingPeriod

      boolean isConsumedRatingPeriod()
      Returns:
      Method to check if rating period is a created during USU rating