com.oracle.communications.brm.cc.modules

Interface ItemModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMItemModule

public interface ItemModule
extends BaseModule

Method Summary

Modifier and Type	Method and Description
List<ArActionsList>	getARActions(String id) Retrieves the list of A/R actions associated with the passed bill item A/R Actions Type like Adjustments, Disputes, Write Off will be retrieved Excluding Payments and Non Currency A/R actions
String	getARItemNo(String poid) This operation gets the item id for the passed id and the type.
BillDetails	getBillDetails(String billId, String expand, String serviceID) gets the services and billItems of the bill
List<BillItem>	getBillItems(String id, String type, boolean isAccountLevel, int noOfBills, String expand) This method gets the bill items based on the following input parameters
BillItem	getDetailsForItem(String billItemObj) Get the details for the Item
List<BillItem>	getItemsForBill(String billId, String type) Gets the bill items for a bill.

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

getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext

Method Detail

getBillItems

List<BillItem> getBillItems(String id,
                            String type,
                            boolean isAccountLevel,
                            int noOfBills,
                            String expand)

This method gets the bill items based on the following input parameters

Parameters:

id - Identifier field e.g for account level it account id

type - Represents the type of bills to be fetched among open or past

isAccountLevel - Flag if get bills at account level or not

noOfBills - Represents the no of bill needs to be fetched

expand - Whether to include children while fetching results

Returns:

List of Bill items

getARItemNo

String getARItemNo(String poid)

This operation gets the item id for the passed id and the type. For ex: if you pass "123" and "/item/payment", this utility method will give you back the Item ID which will look something like "P1-10". Note this utility returns the item id of both billable and non billable item type.

Parameters:

poid - The A/R item id "dispute", "writeoff", "refund", or "cycle_forward".

Returns:

Return ARItem Number

getBillDetails

BillDetails getBillDetails(String billId,
                           String expand,
                           String serviceID)

gets the services and billItems of the bill

Parameters:

billId - The billId for which the billItems has to be retrieved

expand - The accepted values are 'parentonly', 'childonly' ,'all', The FLD_INCLUDE_CHILDREN flag is passed based on this retrieve value

serviceID - The serviceID could be a loginID or a deviceID

Returns:

the BillDetails object has the billItems grouped by services

getARActions

List<ArActionsList> getARActions(String id)

Retrieves the list of A/R actions associated with the passed bill item A/R Actions Type like Adjustments, Disputes, Write Off will be retrieved Excluding Payments and Non Currency A/R actions

Parameters:

id - identifier field bill item id

Returns:

List of Bill Item AR Actions Details

getItemsForBill

List<BillItem> getItemsForBill(String billId,
                               String type)

Gets the bill items for a bill. By default all items are retrieved i.e null value is sent for type. if type="open" is specified then only open bill items will be retrieved if type="closed" is specified then only closed bill items will be retrieved

Parameters:

billId - bill id for which bill items have to be retrieved

type - type of bill items to be retrieved. Values can open or closed or null

Returns:

List of Bill Items

getDetailsForItem

BillItem getDetailsForItem(String billItemObj)

Get the details for the Item

Parameters:

billItemObj -

Returns: