Package net.pricefx.common.apibuilder.rebateagreement

package net.pricefx.common.apibuilder.rebateagreement

The header logic builder for Rebate Agreements, the template builder, and their helpers.

Entry points: the raProcessor binding variable of a Rebate Agreement header logic, and the ratBuilder binding variable of a Rebate Agreement Template logic.

• RebateAgreementBuilder manipulates the Rebate Agreement from its header logic. It adds and updates header inputs and outputs, updates header fields, and changes the folder and item structure. getRebateAgreementView() returns the current document.
• RebateAgreementHelper reads the Rebate Agreement. Obtain it with raProcessor.getHelper(). It adds findAllWithRebateTypeUN(), which returns every line item that carries one Rebate Type unique name.
• RebateAgreementStructure describes code-generated content for one level of the Rebate Agreement folder tree. The parentId of the object defines the level. Pass it to raProcessor.addRebateAgreementStructure().
• RATBuilder constructs a Rebate Agreement from a Rebate Agreement Template logic. Start from an existing agreement with fromExisting() or from a parameter map with fromParams(). Chain the requested changes on the returned builder, then finish with build(). registerPlaceholder() declares a named value that the chain fills in later.
• BasicRebateAgreementBuilder is the shared superclass of RebateAgreementBuilder and of the builder that RATBuilder returns. It contributes build(), which returns the collected changes as a result object.

BasicRebateAgreementBuilder extends CalculableLineItemCollectionBuilder, which carries most of the methods and documents the order in which the collected changes run. RebateAgreementHelper extends LineItemHelper.

See Also:

• Rebate Header Logic (Knowledge Base)
• Rebate Template Simple Working Example (Knowledge Base)

Class	Description
RATBuilder	Builder for a Rebate Agreement Template (RAT).
RATBuilder.RABuilder	Builder for a Rebate Agreement created from a Rebate Agreement Template (RAT).
RebateAgreementBuilder	Context for manipulating a Rebate Agreement object in a rebate agreement header calculation logic.
RebateAgreementHelper	A helper interface that assists in manipulating the rebate agreement object.
RebateAgreementStructure	This is a helper object that is used to build up code-generated content of a Rebate Agreement.