oracle.communication.brm.charging.extensions.client

Interface ExtensionBalance

public interface ExtensionBalance

Exposes balance API to be accessed in customization

Since:

11.2.0.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,java.lang.String>	fetchBalanceDetails() This method Fetches the balance numeric code and beCode
void	generateSpendingLimitNotificationEvents(java.lang.String beCode, UnitValue existingCurrBalanceWithConsumed, UnitValue newCurrBalanceWithConsumed, java.util.Collection<oracle.communication.brm.charging.config.offerprofile.OfferProfile> offerProfiles, java.time.ZonedDateTime eventTime, oracle.communication.brm.charging.extensions.client.notification.UpdateExtensionContext extensionContext) This method Generates the Spending Limit Notification Event
java.util.Map<java.lang.String,oracle.communication.brm.charging.util.misc.Pair<UnitValue,UnitValue>>	getAllRemainingBalance() This method returns the map of remaining balances with key as balance resource code the first value in the pair is remaining balance without credit limit cap; the second value is up to credit limit
UnitValue	getAvailableBalance(java.lang.Integer numericCode) This method calculates and returns the available balance valid at current usage session start time.Calculates and returns the available balance.
UnitValue	getAvailableBalance(java.lang.Integer numericCode, java.lang.String sessionId, java.time.ZonedDateTime sessionStartTime) This method calculates and returns the available balance as applicable at the sessionStartTime passed.
UnitValue	getAvailableBalance(java.lang.String beCode, java.lang.String sessionId, java.time.ZonedDateTime sessionStartTime)
UnitValue	getAvailableBalanceUpToCreditLimit(java.lang.Integer paramInteger) This method returns the Available Balance UpTo CreditLimit
java.lang.String	getBalanceId() This method returns the extension balance Id
ExtensionBusinessProfile	getBusinessProfileDetails() This method returns the extension business profile object
ExtensionCreditProfile	getCreditProfileDetails() This method returns the extension credit profile object that has the details about the credit limits and thresholds.
UnitValue	getCurrentBalance(java.lang.Integer numericCode, java.time.ZonedDateTime sessionStartTime) Returns the current balance for the given resource considering the balance items valid during the specified validity range
java.lang.String	getOwnerId() This method returns the owner Id
UnitValue	getRemainingBalance(java.lang.Integer numericCode) This method returns the remaining balance valid at current usage session start time.
UnitValue	getRemainingBalanceUptoCreditLimit(java.lang.Integer numericCode) This method returns the remaining balance valid at current usage session start time capped at teh credit limit.

Method Detail

getAvailableBalance

UnitValue getAvailableBalance(java.lang.Integer numericCode)

This method calculates and returns the available balance valid at current usage session start time.Calculates and returns the available balance. The logic is: availableBalance = currentBalance - totalReservedBalance The current usage session id's reserved balance is also considered as available. The balance state fetched is prior to applying current usage rating impacts.

Parameters:

numericCode - balanceElement's unique numeric code (eg, 840, 978, etc..)

Returns:

the available balance amount or null if Balance does not contain a BalanceItem for the supplied numeric code and session start time

getAvailableBalance

UnitValue getAvailableBalance(java.lang.Integer numericCode,
                              java.lang.String sessionId,
                              java.time.ZonedDateTime sessionStartTime)

This method calculates and returns the available balance as applicable at the sessionStartTime passed. The logic is: availableBalance = currentBalance - totalReservedBalance If session id is passed, then the reserved amount from it is considered as available and hence is not deducted from current balance.

Note: The reserved amount already has the opposite sign (debit) as current balance (credit) and hence is 'added' in the code below. This method calls the utility method to perform the actual functionality

Parameters:

numericCode - balanceElement's unique numeric code (eg, 840, 978, etc..)

sessionId - that identifies the current session, if null is supplied then the result will be the total unreserved available balance.

sessionStartTime - the session start time

Returns:

the available balance amount or null if Balance does not contain a BalanceItem for the supplied alpha code and range

getAvailableBalance

UnitValue getAvailableBalance(java.lang.String beCode,
                              java.lang.String sessionId,
                              java.time.ZonedDateTime sessionStartTime)

generateSpendingLimitNotificationEvents

void generateSpendingLimitNotificationEvents(java.lang.String beCode,
                                             UnitValue existingCurrBalanceWithConsumed,
                                             UnitValue newCurrBalanceWithConsumed,
                                             java.util.Collection<oracle.communication.brm.charging.config.offerprofile.OfferProfile> offerProfiles,
                                             java.time.ZonedDateTime eventTime,
                                             oracle.communication.brm.charging.extensions.client.notification.UpdateExtensionContext extensionContext)

This method Generates the Spending Limit Notification Event

fetchBalanceDetails

java.util.Map<java.lang.Integer,java.lang.String> fetchBalanceDetails()

This method Fetches the balance numeric code and beCode

getCurrentBalance

UnitValue getCurrentBalance(java.lang.Integer numericCode,
                            java.time.ZonedDateTime sessionStartTime)

Returns the current balance for the given resource considering the balance items valid during the specified validity range

Parameters:

numericCode - resource id

sessionStartTime - Session Start Time

Returns:

current balance

getRemainingBalance

UnitValue getRemainingBalance(java.lang.Integer numericCode)

This method returns the remaining balance valid at current usage session start time.

Parameters:

numericCode - balanceElement's unique numeric code (eg, 840, 978, etc..)

Returns:

the remaining balance amount or null if Balance does not contain a BalanceItem for the supplied numeric code and session start time

getRemainingBalanceUptoCreditLimit

UnitValue getRemainingBalanceUptoCreditLimit(java.lang.Integer numericCode)

This method returns the remaining balance valid at current usage session start time capped at teh credit limit.

Parameters:

numericCode - balanceElement's unique numeric code (eg, 840, 978, etc..)

Returns:

the remaining balance amount or null if Balance does not contain a BalanceItem for the supplied numeric code and session start time

getAllRemainingBalance

java.util.Map<java.lang.String,oracle.communication.brm.charging.util.misc.Pair<UnitValue,UnitValue>> getAllRemainingBalance()

This method returns the map of remaining balances with key as balance resource code the first value in the pair is remaining balance without credit limit cap; the second value is up to credit limit

getCreditProfileDetails

ExtensionCreditProfile getCreditProfileDetails()

This method returns the extension credit profile object that has the details about the credit limits and thresholds.

Returns:

the extension credit profile object

getBusinessProfileDetails

ExtensionBusinessProfile getBusinessProfileDetails()

This method returns the extension business profile object

Returns:

the extension business profile object, null if there is no business profile

getBalanceId

java.lang.String getBalanceId()

This method returns the extension balance Id

getOwnerId

java.lang.String getOwnerId()

This method returns the owner Id

getAvailableBalanceUpToCreditLimit

UnitValue getAvailableBalanceUpToCreditLimit(java.lang.Integer paramInteger)

This method returns the Available Balance UpTo CreditLimit