Package net.pricefx.common.apibuilder.quote


package net.pricefx.common.apibuilder.quote
The header logic builder for Quotes, with its helper and its structure object.

Entry point: the quoteProcessor binding variable of a Quote header logic.

  • QuoteBuilder manipulates the Quote from its header logic. It adds and updates header inputs and outputs, updates header fields, and changes the folder and item structure. getQuoteView() returns the current document.
  • QuoteHelper reads the Quote. Obtain it with quoteProcessor.getHelper().
  • QuoteStructure describes code-generated content for one level of the Quote folder tree. The parentId of the object defines the level. Pass it to quoteProcessor.addQuoteStructure().

The header logic runs twice. The pre-phase runs before the line items are calculated and the post-phase runs after them. Most code belongs in one phase only. Use isPrePhase() and isPostPhase() to tell them apart.

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

See Also:
  • Class
    Description
    QuoteBuilder is the starting point of an interface that allows you to manipulate a quote object in a quote header calculation logic.
    The header calculation is executed twice: Once before the calculation of the individual line items (= pre phase) and once after that (= post phase).
    Usually code should only apply in one phase.
    A helper interface that assists in manipulating the quote object.
    Extends QuoteHelper with operations that are only available when the persisted quote calculation processor is enabled on the QuoteType, i.e. when the line items live in the database rather than in the serialized quote.
    This is a helper object that is used to build up the code-generated content of a quote.