BaseRatingPeriod (Oracle Communications Billing and Revenue Management Elastic Charging Engine Java API Reference)

All Known Subinterfaces:

ExtensionRatingPeriod, RatingPeriodView
```
public interface BaseRatingPeriod
```
Expose rating period API to be accessed in customization

Since:

11.3.0.1

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`getAAResultTags()` Get the value for the generic attribute analyzer tag.
`java.lang.String`	`getAlterationConfigurationName()` Name of the alteration configuration which created this rating period
`java.lang.String`	`getAlterationPricingName()` Return the alteration pricingName which created this rating period This pricingName is the name of the alteration compositePopModelRPE element
`java.lang.String`	`getAlterationRatePlanName()` Name of the alteration rate plan which created this rating period
`java.lang.String`	`getBalanceElementCode()` Method returns the ISO 4217 alphabetic code for the BalanceElement impacted by this RatingPeriod.
`java.lang.Integer`	`getBalanceElementId()` Method returns the ISO 4217 numeric code for the BalanceElement impacted by this RatingPeriod.
`java.lang.String`	`getBalanceId()` Returns the identifier of balance that will impacted
`java.lang.String`	`getChargeRatePlanName()` Name of the charge rate plan which created this rating period
`java.lang.String`	`getCombinedZoneResult()` Return the value for the combined zone result - this is a list of all the values in the zone tag and origZoneResultTag separated by comma
`java.lang.Integer`	`getCorrelationRatingPeriodId()` Gets the correlated rating period identifier.
`java.lang.String`	`getCustomerId()` Returns the customer identifier
`java.lang.String`	`getDiscountInfo()` Provide DiscountInfo field to be available in the extensions
`java.lang.String`	`getFinalZoneResultTag()` This is fhe final zone result after USC/APN.
`java.lang.String`	`getGeneralLedgerCode()` Method returns the general ledger code for the BalanceElement impacted by this RatingPeriod
`UnitValue`	`getImpact()` Method returns the balance element's impact amount associated with this RatingPeriod.
`java.lang.String`	`getImpactCategory()` Gets the newly enriched impact category
`java.lang.String`	`getInitialZoneResultTag()` This is the zone result from zone model (result before USC but after alternate zone model) Note:
`java.lang.String`	`getItemIdentifier()` Gets the item identifier
`java.lang.String`	`getItemType()` If item assignment is enabled, returns the item type based on the item type configuration for the product and event defined in charging configuration.
`java.lang.String`	`getLineage()` Provide Lineage field to be available in the extensions
`java.lang.String`	`getOfferingId()` Method returns the name of the product identifier referred by the purchased product offering.
`java.lang.Integer`	`getOriginalBalanceElementId()` Gets the original charge balance element id prior any override via extensions(e.g currency conversions).
`UnitValue`	`getOriginalImpact()` Gets the original charge impact prior any override via extensions (e.g currency conversions).
`java.lang.String`	`getOrigZoneResultTag()` Deprecated.
`java.lang.String`	`getPricingName()` Return the pricingName which created this rating period This pricingName is the name of the compositePopModelRPE element
`java.lang.String`	`getProductId()` Gets the product associated with the rating period.
`java.lang.String`	`getProductOfferingExternalId()` Method returns the name of the product external ID referred by the purchased product offering.
`java.lang.String`	`getPurchasedProductOfferingId()` Method returns the external identifier of the purchased product offering
`UnitValue`	`getQuantity()` Gets the extension rating period quantity
`java.math.BigDecimal`	`getQuantityFrom()` Start quantity of the extension rating period
`java.math.BigDecimal`	`getQuantityTo()` End quantity of the extension rating period
`java.lang.String`	`getRatePlanSelectorResultTag()` This is the result of executing charge rate plan selector Replaces the older getOrigZoneResultTag() function
`java.lang.String`	`getRateTag()` Provide RateTag field to be available in the extensions
`java.lang.Integer`	`getRatingPeriodId()` Get rating period identifier
`RatingPeriod.RatingPeriodType`	`getRatingPeriodType()` Get enum indicating the type of this rating period.
`java.lang.String`	`getRumName()` Method returns the name of the RUM used to produce this RatingPeriod.
`java.lang.String`	`getTaxCode()` Method returns tax code applicable for this rating period
`TaxJurisdiction`	`getTaxJurisdiction()` Gets the tax jurisdiction details
`TaxTime`	`getTaxTime()` Method returns tax time applicable for this rating period
`java.lang.String`	`getTimeModelName()` Return the name of the time model which created this rating period
`java.lang.String`	`getTimeTag()` Return the value for the time tag
`java.lang.String`	`getUsedZoneModelName()` The zone model of the alternate zone model (if one is present) or the original zone model name (if no alternate zone model is present) Note: If no alternate zone mode exists, this is the same as getZoneModelName().
`java.time.ZonedDateTime`	`getValidityFromTime()` Method returns the start time of grant validity Returns null in case of consumption.
`java.time.ZonedDateTime`	`getValidityToTime()` Method returns the end time of grant validity Returns null in case of consumption.
`java.lang.String`	`getZoneModelName()` Return the name of the zone model which created this rating period The name of the zone model used in getZone(..), before USC or before alternate zone model
`java.lang.String`	`getZoneTag()` Deprecated.
`boolean`	`isCounterImpact()`
`boolean`	`isCurrencyImpact()` Method to check if encapsulated balance element is a currency impact
`boolean`	`isFirstUsageOffer()` Getter
`boolean`	`isFixedImpact()` Method determines if the impact in this rating period if fixed or not
`boolean`	`isRecurringBundleImpact()` Method to indicate this is a rating period is from a daily bundle rate plan

- Method Detail
  - getValidityFromTime
```
java.time.ZonedDateTime getValidityFromTime()
```
    Method returns the start time of grant validity Returns null in case of consumption.
    
    Returns:
    
    the start time of grant validity
  - getValidityToTime
```
java.time.ZonedDateTime getValidityToTime()
```
    Method returns the end time of grant validity Returns null in case of consumption.
    
    Returns:
    
    the end time of grant validity
  - getRumName
```
java.lang.String getRumName()
```
    Method returns the name of the RUM used to produce this RatingPeriod.
    
    Returns:
    
    name of the RUM used to produce this RatingPeriod.
  - getImpact
```
UnitValue getImpact()
```
    Method returns the balance element's impact amount associated with this RatingPeriod.
    
    Returns:
    
    impact amount associated with this RatingPeriod
  - getBalanceElementId
```
java.lang.Integer getBalanceElementId()
```
    Method returns the ISO 4217 numeric code for the BalanceElement impacted by this RatingPeriod.
    
    Returns:
    
    numeric code for the BalanceElement impacted by this RatingPeriod
  - getProductId
```
java.lang.String getProductId()
```
    Gets the product associated with the rating period. Typically this the product identified based on the current usage request.
    
    Returns:
    
    the associated product identifier
  - getGeneralLedgerCode
```
java.lang.String getGeneralLedgerCode()
```
    Method returns the general ledger code for the BalanceElement impacted by this RatingPeriod
    
    Returns:
    
    general ledger code for the BalanceElement impacted by this RatingPeriod
  - getTaxCode
```
java.lang.String getTaxCode()
```
    Method returns tax code applicable for this rating period
    
    Returns:
    
    tax code applicable for this rating period. Null if no tax is applicable for this rating period
  - getTaxTime
```
TaxTime getTaxTime()
```
    Method returns tax time applicable for this rating period
    Supported enum values for TaxTime are:
    - EVENT - Indicates that taxes should be calculated at the event time. Hence will be calculated as a part of charging.
    - BILLING - Indicates that taxes should be calculated by billing system during billing.
    Returns:
    
    tax time applicable for this rating period. Null if no tax is applicable for this rating period
  - getCustomerId
```
java.lang.String getCustomerId()
```
    Returns the customer identifier
    
    Returns:
    
    the customer identifier
  - getBalanceId
```
java.lang.String getBalanceId()
```
    Returns the identifier of balance that will impacted
    
    Returns:
    
    the balance identifier
  - getRatingPeriodType
```
RatingPeriod.RatingPeriodType getRatingPeriodType()
```
    Get enum indicating the type of this rating period.
    Supported enum values for RatingPeriodType are:
    - CHARGE - Indicates rating period is a charge packet
    - ALTERATION - Indicates rating period is an alteration packet
    - DISTRIBUTION - Indicates rating period is a charge packet
    - TAX_ON_CHARGE - Indicates rating period represents tax on a distribution packet
    - TAX_ON_ALTERATION - Indicates rating period represents tax on a alteration packet
    - TAX_ON_DISTRIBUTION - Indicates rating period represents tax on a distribution packet
    Returns:
    
    type type of rating period
  - getItemType
```
java.lang.String getItemType()
```
    If item assignment is enabled, returns the item type based on the item type configuration for the product and event defined in charging configuration.
    
    Returns:
    
    the item type based on configuration or null if item assignment is disabled,
  - getItemIdentifier
```
java.lang.String getItemIdentifier()
```
    Gets the item identifier
    
    Returns:
    
    the item identifier or null if item assignment is disabled,
  - getTaxJurisdiction
```
TaxJurisdiction getTaxJurisdiction()
```
    Gets the tax jurisdiction details
    
    Returns:
  - getQuantity
```
UnitValue getQuantity()
```
    Gets the extension rating period quantity
    
    Returns:
    
    gets the extension rating period quantity
  - getZoneTag
```
@Deprecated
java.lang.String getZoneTag()
```
    Deprecated.
    
    Return the value for the zone tag
    
    Returns:
    
    tag value
  - getFinalZoneResultTag
```
java.lang.String getFinalZoneResultTag()
```
    This is fhe final zone result after USC/APN. This replaces the older, deprecated getZoneTag() function
    
    Returns:
  - getTimeTag
```
java.lang.String getTimeTag()
```
    Return the value for the time tag
    
    Returns:
    
    tag value
  - getPricingName
```
java.lang.String getPricingName()
```
    Return the pricingName which created this rating period This pricingName is the name of the compositePopModelRPE element
    
    Returns:
    
    tag value
  - getZoneModelName
```
java.lang.String getZoneModelName()
```
    Return the name of the zone model which created this rating period The name of the zone model used in getZone(..), before USC or before alternate zone model
    
    Returns:
    
    This zoneModelName is the name of the zone model used to create this rating period
  - getTimeModelName
```
java.lang.String getTimeModelName()
```
    Return the name of the time model which created this rating period
    
    Returns:
    
    The timeModelName is the name of the time model used to create this rating period
  - getChargeRatePlanName
```
java.lang.String getChargeRatePlanName()
```
    Name of the charge rate plan which created this rating period
    
    Returns:
    
    The name of the charge rate plan which created this rating period
  - getImpactCategory
```
java.lang.String getImpactCategory()
```
    Gets the newly enriched impact category
    
    Returns:
    
    returns the newly enriched impact category
  - getQuantityFrom
```
java.math.BigDecimal getQuantityFrom()
```
    Start quantity of the extension rating period
    
    Returns:
    
    gets start quantity of the extension rating period
  - getQuantityTo
```
java.math.BigDecimal getQuantityTo()
```
    End quantity of the extension rating period
    
    Returns:
    
    gets end quantity of the extension rating period
  - isRecurringBundleImpact
```
boolean isRecurringBundleImpact()
```
    Method to indicate this is a rating period is from a daily bundle rate plan
    
    Returns:
    
    true if impact is from daily bundle
  - getAAResultTags
```
java.lang.String[] getAAResultTags()
```
    Get the value for the generic attribute analyzer tag. If there are multiple analyzer tags then it will a list of tag values. (e.g [REGULAR_DOWNLOAD,REGULAR_DOWNLOAD_PEAK])
    
    Returns:
    
    gets the value for the generic attribute analyzer tag
  - getBalanceElementCode
```
java.lang.String getBalanceElementCode()
```
    Method returns the ISO 4217 alphabetic code for the BalanceElement impacted by this RatingPeriod.
    
    Returns:
    
    alpha code for the BalanceElement impacted by this RatingPeriod
  - getPurchasedProductOfferingId
```
java.lang.String getPurchasedProductOfferingId()
```
    Method returns the external identifier of the purchased product offering
    
    Returns:
    
    External Id of the purchased product offering ok
  - getOfferingId
```
java.lang.String getOfferingId()
```
    Method returns the name of the product identifier referred by the purchased product offering.
    
    Returns:
    
    name of the product offering
  - getProductOfferingExternalId
```
java.lang.String getProductOfferingExternalId()
```
    Method returns the name of the product external ID referred by the purchased product offering.
    
    Returns:
    
    externalId of the product offering ok
  - getOrigZoneResultTag
```
@Deprecated
java.lang.String getOrigZoneResultTag()
```
    Deprecated.
    
    Return the value for the original zone result tag (specific method for getting a original zone result tag value without having to know the original zone result key tag name) Deprecated: Use getRatePlanSelectorResultTag() instead
    
    Returns:
    
    tag value
  - getRatePlanSelectorResultTag
```
java.lang.String getRatePlanSelectorResultTag()
```
    This is the result of executing charge rate plan selector Replaces the older getOrigZoneResultTag() function
    
    Returns:
    
    The result of executing charge rate plan selector
  - getCombinedZoneResult
```
java.lang.String getCombinedZoneResult()
```
    Return the value for the combined zone result - this is a list of all the values in the zone tag and origZoneResultTag separated by comma
    
    Returns:
    
    tag value
  - isCounterImpact
```
boolean isCounterImpact()
```
    Returns:
    
    returns flag indicating whether the impact is for a counter type of resource
  - isFirstUsageOffer
```
boolean isFirstUsageOffer()
```
    Getter
    
    Returns:
    
    true if associated purchased offer is a first usage offer
  - isFixedImpact
```
boolean isFixedImpact()
```
    Method determines if the impact in this rating period if fixed or not
    
    Returns:
    
    true if the impact is fixed, false otherwise
  - isCurrencyImpact
```
boolean isCurrencyImpact()
```
    Method to check if encapsulated balance element is a currency impact
    
    Returns:
    
    true if impact is a currency impact
  - getUsedZoneModelName
```
java.lang.String getUsedZoneModelName()
```
    The zone model of the alternate zone model (if one is present) or the original zone model name (if no alternate zone model is present) Note: If no alternate zone mode exists, this is the same as getZoneModelName(). However is an alternate zone model exists, this can be different from getZoneModelName()
    
    Returns:
    
    The name of the evaluated zone model
  - getInitialZoneResultTag
```
java.lang.String getInitialZoneResultTag()
```
    This is the zone result from zone model (result before USC but after alternate zone model) Note:
    
    Returns:
    
    This is the zone result from zone model (result before USC but after alternate zone model)
  - getRatingPeriodId
```
java.lang.Integer getRatingPeriodId()
```
    Get rating period identifier
    
    Returns:
    
    ratingPeriod
  - getCorrelationRatingPeriodId
```
java.lang.Integer getCorrelationRatingPeriodId()
```
    Gets the correlated rating period identifier. e.g for tax rating period - it gets the corresponding charge, alteration or distribution period id for which the tax was applicable. for alteration rating period - it gets the corresponding charge period id for which the alteration was applicable. for distribution rating period - it gets the corresponding charge or alteration period id for which the distribution was applicable.
    
    Returns:
    
    correlationRatingPeriodId - the co-related rating period id
  - getOriginalBalanceElementId
```
java.lang.Integer getOriginalBalanceElementId()
```
    Gets the original charge balance element id prior any override via extensions(e.g currency conversions). Returns null if never modified
    
    Returns:
    
    original charge balance element id prior any override via extensions.
  - getOriginalImpact
```
UnitValue getOriginalImpact()
```
    Gets the original charge impact prior any override via extensions (e.g currency conversions). Returns null if never modified
    
    Returns:
    
    original charge impact prior any override via extensions
  - getDiscountInfo
```
java.lang.String getDiscountInfo()
```
    Provide DiscountInfo field to be available in the extensions
    
    Returns:
    
    DiscountInfo field as set in the extensions
  - getRateTag
```
java.lang.String getRateTag()
```
    Provide RateTag field to be available in the extensions
    
    Returns:
    
    RateTag field as set in the extensions
  - getLineage
```
java.lang.String getLineage()
```
    Provide Lineage field to be available in the extensions
    
    Returns:
    
    Lineage field as set in the extensions
  - getAlterationRatePlanName
```
java.lang.String getAlterationRatePlanName()
```
    Name of the alteration rate plan which created this rating period
    
    Returns:
    
    The name of the alteration rate plan which created this rating period
  - getAlterationConfigurationName
```
java.lang.String getAlterationConfigurationName()
```
    Name of the alteration configuration which created this rating period
    
    Returns:
    
    The name of the alteration configuration which created this rating period
  - getAlterationPricingName
```
java.lang.String getAlterationPricingName()
```
    Return the alteration pricingName which created this rating period This pricingName is the name of the alteration compositePopModelRPE element
    
    Returns:
    
    tag value

Interface BaseRatingPeriod

Method Summary

Method Detail

getValidityFromTime

getValidityToTime

getRumName

getImpact

getBalanceElementId

getProductId

getGeneralLedgerCode

getTaxCode

getTaxTime

getCustomerId

getBalanceId

getRatingPeriodType

getItemType

getItemIdentifier

getTaxJurisdiction

getQuantity

getZoneTag

getFinalZoneResultTag

getTimeTag

getPricingName

getZoneModelName

getTimeModelName

getChargeRatePlanName

getImpactCategory

getQuantityFrom

getQuantityTo

isRecurringBundleImpact

getAAResultTags

getBalanceElementCode

getPurchasedProductOfferingId

getOfferingId

getProductOfferingExternalId

getOrigZoneResultTag

getRatePlanSelectorResultTag

getCombinedZoneResult

isCounterImpact

isFirstUsageOffer

isFixedImpact

isCurrencyImpact

getUsedZoneModelName

getInitialZoneResultTag

getRatingPeriodId

getCorrelationRatingPeriodId

getOriginalBalanceElementId

getOriginalImpact

getDiscountInfo

getRateTag

getLineage

getAlterationRatePlanName

getAlterationConfigurationName

getAlterationPricingName