Class RebateAgreementBuilder

All Implemented Interfaces:
CompensationAgreementBuilder

public class RebateAgreementBuilder extends BasicRebateAgreementBuilder<RebateAgreementBuilder> implements CompensationAgreementBuilder
IMPORTANT: Please read super class notes on sequence of execution!
  • Method Details

    • getRebateAgreementView

      public Object getRebateAgreementView()
      Gets the full rebate agreement object as a nested map. This map contains all header inputs/outputs, and all line items (with their inputs/outputs).

      Caution: when using Classic or Unity non-React user interface, then during pre-phase, the raProcessor.rebateAgreementView will NOT contain values of Outputs. The only exception are "overridable" outputs. This limitation is because of performance optimization of amount of data being sent between user interface and backend.

      Returns:
      The rebate agreement object
    • getHelper

      public RebateAgreementHelper getHelper()
      Gets a helper class that assists in manipulating the Rebate Agreement object. You can use it instead of directly reading the getRebateAgreementView map.
      Returns:
      a helper class
    • addRebateAgreementStructure

      public RebateAgreementBuilder addRebateAgreementStructure(RebateAgreementStructure structure)
      Builds a Rebate Agreement structure. That usually means adding a set of folders and/or items.
      Example:
      
       def rbas = new RebateAgreementStructure()
       rbas.addFolder("folderOne")
      
       raProcessor.addRebateAgreementStructure(rbas)
       
      Parameters:
      structure -
      Returns:
      the RebateAgreementStructure object
    • addFolder

      public void addFolder(String label)
      Creates and adds a new folder under the ROOT folder.
      
       def fld = raProcessor.addFolder("folderTwo")
       

      If you intend to add many folders and items, use the RebateAgreementStructure approach instead.