Package net.pricefx.common.apibuilder.rebateagreement

Interface RATBuilder.RABuilder

All Superinterfaces:

CalculableLineItemCollectionBuilder<RATBuilder.RABuilder>

Enclosing interface:

RATBuilder

public static interface RATBuilder.RABuilder
extends CalculableLineItemCollectionBuilder<RATBuilder.RABuilder>

Builder for a Rebate Agreement created from a Rebate Agreement Template (RAT). Obtained via RATBuilder.fromExisting(String) or RATBuilder.fromParams(java.util.Map).

See Also:

• RATBuilder

Field Summary

Fields inherited from interface CalculableLineItemCollectionBuilder

ROOT_LINE_ID

Method Summary

Modifier and Type	Method	Description
RATBuilder.RABuilder	addLineItemWithId(String lineId, String rebateType)	Adds a new line item to the Rebate Agreement, specified by the Rebate Type unique name.
RATBuilder.RABuilder	addLineItemWithId(String parentId, String lineId, String rebateType)	Adds a new line item to the specified parent folder of the Rebate Agreement. Example:
RATBuilder.RABuilder	applyPlaceholder(String placeholder, Object value)	Applies a value to a previously registered placeholder.
String	getIstanceId()
RATBuilder.RABuilder	submitAfterBuild()	Marks that the built Rebate Agreement should be submitted after build.

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

getIstanceId

String getIstanceId()

Returns:

the instance id of this builder

addLineItemWithId

RATBuilder.RABuilder addLineItemWithId(String lineId,
 String rebateType)

Adds a new line item to the Rebate Agreement, specified by the Rebate Type unique name.

Parameters:

lineId - usually a generated id

rebateType - uniqueName of the Rebate Agreement Type

Returns:

itself

addLineItemWithId

RATBuilder.RABuilder addLineItemWithId(String parentId,
 String lineId,
 String rebateType)

Adds a new line item to the specified parent folder of the Rebate Agreement.
Example:

.addLineItemWithId("ROOT", lineCustomerId, "Rebate Program")

Parameters:

parentId - the name of the folder you want to add a line item to

lineId - usually a randomly generated id

rebateType - uniqueName of the Rebate Agreement Type

Returns:

itself

applyPlaceholder

RATBuilder.RABuilder applyPlaceholder(String placeholder,
 Object value)

Applies a value to a previously registered placeholder.

Parameters:

placeholder - the placeholder name

value - the value to apply

Returns:

itself

submitAfterBuild

RATBuilder.RABuilder submitAfterBuild()

Marks that the built Rebate Agreement should be submitted after build.

Returns:

itself