Class RebateAgreementBuilder
Object
ObjectIdentity
AbstractBuilder
- All Implemented Interfaces:
CompensationAgreementBuilder
public class RebateAgreementBuilder
extends BasicRebateAgreementBuilder<RebateAgreementBuilder>
implements CompensationAgreementBuilder
IMPORTANT: Please read super class notes on sequence of execution!
-
Field Summary
Fields inherited from class CalculableLineItemCollectionBuilder
METHOD_ADD_LINE_ITEM, METHOD_ADD_OR_UPDATE_INPUT, METHOD_ADD_OR_UPDATE_OUTPUT, METHOD_UPDATE_FIELD, phase, ROOT_LINE_ID
Fields inherited from class AbstractBuilder
METHOD_BUILD
Fields inherited from class ObjectIdentity
classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Creates and adds a new folder under the ROOT folder.Builds a Rebate Agreement structure.Gets a helper class that assists in manipulating the Rebate Agreement object.Gets the full rebate agreement object as a nested map.Methods inherited from class BasicRebateAgreementBuilder
build
Methods inherited from class CalculableLineItemCollectionBuilder
addLineItem, addLineItem, addLineItem, addOrUpdateInput, addOrUpdateInput, addOrUpdateOutput, addOrUpdateOutput, clearRenderInfo, deleteItem, isPostPhase, isPrePhase, moveItem, renameFolder, setRenderInfo, updateField, updateField
Methods inherited from class ObjectIdentity
addInvocation, addInvocation
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface CompensationAgreementBuilder
build
-
Method Details
-
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
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
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
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.
-