Package net.pricefx.common.apibuilder.rebateagreement

Interface RebateAgreementBuilder

All Superinterfaces:

CalculableLineItemCollectionBuilder<RebateAgreementBuilder>

public interface RebateAgreementBuilder
extends CalculableLineItemCollectionBuilder<RebateAgreementBuilder>

Context for manipulating a Rebate Agreement object in a rebate agreement header calculation logic.

IMPORTANT: Please read super interface notes on the sequence of execution!

See Also:

• CalculableLineItemCollectionBuilder

Field Summary

Fields inherited from interface CalculableLineItemCollectionBuilder

ROOT_LINE_ID

Method Summary

Modifier and Type	Method	Description
void	addFolder(String label)	Creates and adds a new folder under the ROOT folder.
RebateAgreementBuilder	addRebateAgreementStructure(RebateAgreementStructure structure)	Builds a Rebate Agreement structure.
RebateAgreementHelper	getHelper()	Gets a helper that assists in manipulating the Rebate Agreement object.
Object	getRebateAgreementView()	Gets the full rebate agreement object as a nested map.

Methods inherited from interface CalculableLineItemCollectionBuilder

addLineItem, addLineItem, addLineItem, addOrUpdateInput, addOrUpdateInput, addOrUpdateOutput, addOrUpdateOutput, clearRenderInfo, closeFolder, deleteFolder, deleteItem, deselectItem, isPostPhase, isPrePhase, markItemDirty, moveItem, openFolder, renameFolder, selectItem, setRenderInfo, switchToAsync, updateField, updateField

Method Details

getRebateAgreementView

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.

Returns:

The rebate agreement object

getHelper

RebateAgreementHelper getHelper()

Gets a helper that assists in manipulating the Rebate Agreement object. You can use it instead of directly reading the getRebateAgreementView map.

Returns:

the helper

addRebateAgreementStructure

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 - the structure

Returns:

itself (for flow pattern)

addFolder

void addFolder(String label)

Creates and adds a new folder under the ROOT folder.

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

Parameters:

label - the folder label