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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExtensionRatingPeriod.Source
static class	ExtensionRatingPeriod.State Enum indicating the rating period current state It indicates whether the rating period is newly created, modified or unmodified.

Method Summary

Modifier and Type	Method and Description
void	enrichImpactCategory(java.lang.String enrichedImpactCategory) Sets the enriched impact category.
QuantityRange	getActualQty() Get The actualQuatity of the RP
oracle.communication.brm.charging.config.offerprofile.OfferProfile	getOfferProfile() The OfferProfile which created/is associated with this RatingPeriod
java.lang.String	getOrigZoneTag() Deprecated.
oracle.communication.brm.charging.util.misc.Pair<java.lang.Integer,java.lang.Long>	getRecurringBundleDetails() Overridden recurring bundle information
ExtensionRatingPeriod.Source	getSource() Whether this was created by externally in extension or by ECE internally (and modified)
java.math.BigDecimal	getTaxRate() Overridden tax rate
Range	getTimeRange() Overridden time range
boolean	isDeletedExtRatingPeriod() Returns true if it is a deleted rating period
boolean	isFirstUsageGrant() {true}, if this extension rating period is a first usage grant
boolean	isNewlyAddedExtRatingPeriod() Returns true if it is a newly added rating period
void	markForDeletion() Marks the rating period for deletion
void	modifyBalanceElement(java.lang.Integer balanceElementId) Modifies the balance element id and code
void	modifyBalanceElementCode(java.lang.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.
void	modifyDiscountInfo(java.lang.String discountInfo) Modifies the discount information associated with the RatingPeriod
void	modifyGeneralLedgerCode(java.lang.String glCode) Modifies the the general ledger code for BalanceElement impacted by this RatingPeriod
void	modifyImpact(UnitValue modifiedImpact) Modifies the balance impact amount
void	modifyItemType(java.lang.String itemType) Modifies the item Type associated with the RatingPeriod
void	modifyLineage(java.lang.String lineage) Modifies the lineage associated with the RatingPeriod
void	modifyRateTag(java.lang.String rateTag) Modifies the rate tag associated with the RatingPeriod
void	modifyTaxCode(java.lang.String taxCode) Modifies the tax Code for associated with the RatingPeriod
void	modifyTaxJurisdiction(java.math.BigDecimal taxAmount, java.math.BigDecimal taxExempt, java.math.BigDecimal amountForTaxation, java.math.BigDecimal amountTaxed, java.lang.String name, java.math.BigDecimal taxPercent, int type) Modify the tax jurisdiction details
void	setTaxRate(java.math.BigDecimal taxRate) modifies the tax packet with new tax code information

Methods inherited from interface oracle.communication.brm.charging.extensions.client.BaseRatingPeriod

getAAResultTags, getAlterationConfigurationName, getAlterationPricingName, getAlterationRatePlanName, getBalanceElementCode, getBalanceElementId, getBalanceId, getChargeRatePlanName, getCombinedZoneResult, getCorrelationRatingPeriodId, getCustomerId, getDiscountInfo, getFinalZoneResultTag, getGeneralLedgerCode, getImpact, getImpactCategory, getInitialZoneResultTag, getItemIdentifier, getItemType, getLineage, getOfferingId, getOriginalBalanceElementId, getOriginalImpact, getOrigZoneResultTag, getPricingName, getProductId, getProductOfferingExternalId, getPurchasedProductOfferingId, getQuantity, getQuantityFrom, getQuantityTo, getRatePlanSelectorResultTag, getRateTag, getRatingPeriodId, getRatingPeriodType, getRumName, getTaxCode, getTaxJurisdiction, getTaxTime, getTimeModelName, getTimeTag, getUsedZoneModelName, getValidityFromTime, getValidityToTime, getZoneModelName, getZoneTag, isCounterImpact, isCurrencyImpact, isFirstUsageOffer, isFixedImpact, isRecurringBundleImpact

Method Detail

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
java.lang.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(java.lang.Integer balanceElementId)

Modifies the balance element id and code

Parameters:

balanceElementId - - ISO balance element Id

modifyBalanceElementCode

void modifyBalanceElementCode(java.lang.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(java.lang.String glCode)

Modifies the the general ledger code for BalanceElement impacted by this RatingPeriod

Parameters:

glCode - - the general ledger code

enrichImpactCategory

void enrichImpactCategory(java.lang.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(java.lang.String taxCode)

Modifies the tax Code for associated with the RatingPeriod

Parameters:

taxCode - - the tax Code

modifyItemType

void modifyItemType(java.lang.String itemType)

Modifies the item Type associated with the RatingPeriod

Parameters:

itemType - - the item Type

modifyTaxJurisdiction

void modifyTaxJurisdiction(java.math.BigDecimal taxAmount,
                           java.math.BigDecimal taxExempt,
                           java.math.BigDecimal amountForTaxation,
                           java.math.BigDecimal amountTaxed,
                           java.lang.String name,
                           java.math.BigDecimal taxPercent,
                           int type)

Modify the tax jurisdiction details

Parameters:

taxAmount -

taxExempt -

amountForTaxation -

amountTaxed -

name -

taxPercent -

type -

modifyRateTag

void modifyRateTag(java.lang.String rateTag)

Modifies the rate tag associated with the RatingPeriod

Parameters:

rateTag - - the rate tag

modifyLineage

void modifyLineage(java.lang.String lineage)

Modifies the lineage associated with the RatingPeriod

Parameters:

lineage - - the lineage

modifyDiscountInfo

void modifyDiscountInfo(java.lang.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

java.math.BigDecimal getTaxRate()

Overridden tax rate

Returns:

The overridden tax rate

setTaxRate

void setTaxRate(java.math.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<java.lang.Integer,java.lang.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

QuantityRange getActualQty()

Get The actualQuatity of the RP

Returns: