com.oracle.communications.brm.cc.modules

Interface BillUnitModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMBillUnitModule

public interface BillUnitModule
extends BaseModule

Interface for BillUnit functions

Method Summary

Modifier and Type	Method and Description
void	addOrUpdateBillUnitHierarchy(BillUnitHierarchy billUnitHierarchy, String billUnitId) add or updates the Parent BillUnit for given bill unit.
void	changeValidity(String id, ChangeValidity changeValidity) This method changes the validity non currency resource
BillUnit	createBillUnit(BillUnit billUnit) Creates a new bill unit
TransferBalanceCreateResponse	createTransferBalance(TransferBalance transferBalance) Transfer the currency/non currency balances between source and destination balance_group.
AccountSummary	getAccountSummary(String id) Retrieves consolidated summary of all bill unit for account with ID summary contains dueNow, pendingDue, unallocatedPayments and disputed
BillingHierarchy	getAllChildBillUnits(String billUnitID, String expandFlag) Retrieves the all child for given bill unit.
BillUnit	getBalanceGroups(String id, boolean includeBalanceMonitor) Get List of balance groups with balances in a given bill unit
List<BillUnit>	getBillUnits(String id) Retrieves the bill unit(s) of the account
List<BillUnit>	getBillUnitsFromAcctId(String accountId) Get bill info data from accountId
AccountSummary	getBillUnitSummary(String billUnitID, String arBillUnitID, boolean isParentBillUnit) Retrieves the summary for given bill unit.
TransferBalanceDetails	getTransferBalance(String id) Get the details of the currency/non currency balance transfer for the specified transfer event
List<TransferBalanceDetails>	getTransferBalanceList(String id, String sourceId, String targetId, String sourceRefType, String targetRefType) Get the details of the currency/non currency balance transfer for the specified balance_group
List<BillUnit>	moveBalanceGroup(List<NewBillUnit> billUnits) This method will move Balance group between Bill Units
void	removeBillUnitHierarchy(BillUnitHierarchy billUnitHierarchy, String billUnitId) removes the Parent BillUnit for given bill unit.
void	setCreditLimit(String id, CreditLimit creditLimit) This method sets credit limit for currency/non currency balance group
BillUnit	updateBillUnit(BillUnit billUnit, Boolean billNow) Updates the Bill unit details for the given Account

Methods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule

getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext

Method Detail

getAccountSummary

AccountSummary getAccountSummary(String id)

Retrieves consolidated summary of all bill unit for account with ID summary contains dueNow, pendingDue, unallocatedPayments and disputed

Parameters:

id - Account number for which balance needs to be retrieved

Returns:

instance of AccountSummary

getBillUnitSummary

AccountSummary getBillUnitSummary(String billUnitID,
                                  String arBillUnitID,
                                  boolean isParentBillUnit)

Retrieves the summary for given bill unit. Summary contains data like Past Due, Current Due, Bill In Progress and Due Date *

Parameters:

billUnitID - The bill unit ID for witch summary is retrieved

arBillUnitID - The AR bill unit ID for bill unit

isParentBillUnit -

Returns:

AccountSummary

updateBillUnit

BillUnit updateBillUnit(BillUnit billUnit,
                        Boolean billNow)

Updates the Bill unit details for the given Account

Parameters:

billUnit - Bill Unit Object with data to update

billNow - true if the due is paid by current parent and want to do Bill now

Returns:

getBalanceGroups

BillUnit getBalanceGroups(String id,
                          boolean includeBalanceMonitor)

Get List of balance groups with balances in a given bill unit

Parameters:

id - Bill Unit Id

includeBalanceMonitor -

Returns:

BillUnit Object with balance group details

moveBalanceGroup

List<BillUnit> moveBalanceGroup(List<NewBillUnit> billUnits)

This method will move Balance group between Bill Units

Parameters:

billUnits -

Returns:

addOrUpdateBillUnitHierarchy

void addOrUpdateBillUnitHierarchy(BillUnitHierarchy billUnitHierarchy,
                                  String billUnitId)

add or updates the Parent BillUnit for given bill unit.

Parameters:

billUnitHierarchy -

billUnitId - Bill Unit Id

removeBillUnitHierarchy

void removeBillUnitHierarchy(BillUnitHierarchy billUnitHierarchy,
                             String billUnitId)

removes the Parent BillUnit for given bill unit.

Parameters:

billUnitHierarchy -

billUnitId - Bill Unit Id

createBillUnit

BillUnit createBillUnit(BillUnit billUnit)

Creates a new bill unit

Parameters:

billUnit - Bill Unit Object with data to be created

Returns:

getBillUnits

List<BillUnit> getBillUnits(String id)

Retrieves the bill unit(s) of the account

Parameters:

id - Account ID to retrieve the bill units

Returns:

list of 'BillUnit' payloads corresponding to 'billUnit' schema

getBillUnitsFromAcctId

List<BillUnit> getBillUnitsFromAcctId(String accountId)

Get bill info data from accountId

Parameters:

accountId -

Returns:

setCreditLimit

void setCreditLimit(String id,
                    CreditLimit creditLimit)

This method sets credit limit for currency/non currency balance group

Parameters:

id - of balance group

creditLimit -

changeValidity

void changeValidity(String id,
                    ChangeValidity changeValidity)

This method changes the validity non currency resource

Parameters:

id - resource id

changeValidity -

getAllChildBillUnits

BillingHierarchy getAllChildBillUnits(String billUnitID,
                                      String expandFlag)

Retrieves the all child for given bill unit.

Parameters:

billUnitID - The bill unit ID for witch all children are retrieved

expandFlag - Flag to retrieve children details

Returns:

BillingHierarchy

createTransferBalance

TransferBalanceCreateResponse createTransferBalance(TransferBalance transferBalance)

Transfer the currency/non currency balances between source and destination balance_group.

Parameters:

transferBalance - payload representing TransferBalance schema.

Returns:

TransferBalanceCreateResponse

getTransferBalanceList

List<TransferBalanceDetails> getTransferBalanceList(String id,
                                                    String sourceId,
                                                    String targetId,
                                                    String sourceRefType,
                                                    String targetRefType)

Get the details of the currency/non currency balance transfer for the specified balance_group

Parameters:

id - The balance_group id for which the balance transfer details needs to be fetched.

sourceId - source Id

targetId - target Id

sourceRefType - type of the sourceId

targetRefType - type of the targetId

Returns:

List<TransferBalanceDetails>

getTransferBalance

TransferBalanceDetails getTransferBalance(String id)

Get the details of the currency/non currency balance transfer for the specified transfer event

Parameters:

id - The transfer event id for which the balance transfer details needs to be fetched.

Returns:

TransferBalanceDetails