Interface DisputeModule
- All Superinterfaces:
BaseModule
- All Known Implementing Classes:
PCMDisputeModule
DisputeModule for dispute related operations. extends : BaseModule
-
Method Summary
Modifier and TypeMethodDescriptiondisputeBill
(String id, DisputeBill disputeBill) Performs dispute for a billdisputeEvent
(DisputeEvent disputeEvent) Performs dispute for an eventdisputeItem
(String id, DisputeItem disputeItem) Performs dispute for an itemNeeds to be cleaned up so as to return dispute details object Returns the notes details for the dispute of the passed bill idgetOpenDisputes
(String id, String expand) Given an account id, this method returns all open disputes of that accountGiven an bill id, this method returns all open disputes of that billgetSettlementDetails
(String id, String accountId, String billunitId, String billId) Get the settlement detailssettleBillDispute
(String id, SettlementBill settleBillDispute) Performs settlement of a bill disputesettleEventDispute
(String id, SettlementEvent settleEventDispute) Performs settlement for an event disputesettleItemDispute
(String id, SettlementItem settleItemDispute) Performs settlement for an item in disputeMethods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule
getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext
-
Method Details
-
disputeBill
Performs dispute for a bill- Parameters:
id
- : id of the bill in disputedisputeBill
- : payload based on disputeBill schema- Returns:
- disputeId when dispute is successful, else null
-
settleBillDispute
Performs settlement of a bill dispute- Parameters:
id
- : id of the bill in dispute undergoing for SettlementsettleBillDispute
- : payload based on settleBillDispute schema- Returns:
- settlementId when Settlement is successful, else null
-
getNotes
Needs to be cleaned up so as to return dispute details object Returns the notes details for the dispute of the passed bill id- Parameters:
id
- : id of the bill in dispute undergoing for Settlement- Returns:
- NotesInfo object comprising of comments for dispute.
-
getOpenDisputes
Given an account id, this method returns all open disputes of that account- Parameters:
id
- : account idexpand
- : ("all" or "childonly") to know whether to include child accounts or not- Returns:
- list of open disputes
-
getOpenDisputesForBill
Given an bill id, this method returns all open disputes of that bill- Parameters:
id
- : bill id- Returns:
- list of open disputes
-
getSettlementDetails
SettlementDetails getSettlementDetails(String id, String accountId, String billunitId, String billId) Get the settlement details- Parameters:
id
- (settlement ID/Dispute ID for which settlement details is required)accountId
- (optional field)billunitId
- (optional field)billId
- (optional field)- Returns:
- : settlement details
-
settleItemDispute
Performs settlement for an item in dispute- Parameters:
id
- : id an item in disputesettleItemDispute
- : payload based on settleItemDispute schema- Returns:
- settlementId when Settlement is successful, else null
-
disputeItem
Performs dispute for an item- Parameters:
id
- : id of the item to be disputeddisputeItem
- : payload based on disputeItem schema- Returns:
- disputeId when dispute is successful, else null
-
disputeEvent
Performs dispute for an event- Parameters:
disputeEvent
- : payload based on DisputeEvent schema- Returns:
- dispute Id
-
settleEventDispute
Performs settlement for an event dispute- Parameters:
id
- dispute IDsettleEventDispute
- : payload based on SettlementEvent schema- Returns:
- settlement Id
-