Package com.oracle.communications.brm.cc.modules

Interface DisputeModule

All Superinterfaces:
BaseModule
All Known Implementing Classes:
PCMDisputeModule
public interface DisputeModule extends BaseModule
DisputeModule for dispute related operations. extends : BaseModule

  • Method Details

    • disputeBill

      String disputeBill(String id, DisputeBill disputeBill)
      Performs dispute for a bill
      Parameters:
      id - : id of the bill in dispute
      disputeBill - : payload based on disputeBill schema
      Returns:
      disputeId when dispute is successful, else null

    • settleBillDispute

      String settleBillDispute(String id, SettlementBill settleBillDispute)
      Performs settlement of a bill dispute
      Parameters:
      id - : id of the bill in dispute undergoing for Settlement
      settleBillDispute - : payload based on settleBillDispute schema
      Returns:
      settlementId when Settlement is successful, else null

    • getNotes

      NotesInfo getNotes(String id)
      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

      List<ArActionsList> getOpenDisputes(String id, String expand)
      Given an account id, this method returns all open disputes of that account
      Parameters:
      id - : account id
      expand - : ("all" or "childonly") to know whether to include child accounts or not
      Returns:
      list of open disputes

    • getOpenDisputesForBill

      List<ArActionsList> getOpenDisputesForBill(String id)
      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

      String settleItemDispute(String id, SettlementItem settleItemDispute)
      Performs settlement for an item in dispute
      Parameters:
      id - : id an item in dispute
      settleItemDispute - : payload based on settleItemDispute schema
      Returns:
      settlementId when Settlement is successful, else null

    • disputeItem

      String disputeItem(String id, DisputeItem disputeItem)
      Performs dispute for an item
      Parameters:
      id - : id of the item to be disputed
      disputeItem - : payload based on disputeItem schema
      Returns:
      disputeId when dispute is successful, else null

    • disputeEvent

      String disputeEvent(DisputeEvent disputeEvent)
      Performs dispute for an event
      Parameters:
      disputeEvent - : payload based on DisputeEvent schema
      Returns:
      dispute Id

    • settleEventDispute

      String settleEventDispute(String id, SettlementEvent settleEventDispute)
      Performs settlement for an event dispute
      Parameters:
      id - dispute ID
      settleEventDispute - : payload based on SettlementEvent schema
      Returns:
      settlement Id