Class QuoteBuilder


  • public class QuoteBuilder
    extends CalculableLineItemCollectionBuilder<QuoteBuilder>
    QuoteBuilder is the starting point of an interface that allows you 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. Use isPrePhase() and isPostPhase() methods to detect current phase.
    The quote builder is available in the header logic by this call:
    def builder = quoteProcessor

    IMPORTANT: Please read super class notes on sequence of execution!
    • Method Detail

      • getQuoteView

        public Object getQuoteView()
        Gets the full quote object as a nested map. This map contains all header inputs/outputs, and all line items (with their inputs/outputs).
        Returns:
        The quote object
      • getHelper

        public QuoteHelper getHelper()
        Gets a helper class that assists in manipulating the quote object. You can use it instead of directly reading the QuoteView map.
        Returns:
        The helper object,
      • addQuoteStructure

        public QuoteBuilder addQuoteStructure​(QuoteStructure structure)
        Apply a quote structure. That usually means adding a set of folders and/or items

        Example:

         if (quoteProcessor.isPrePhase()) {
              def structure = new QuoteStructure()
              productSubCategory.each {
                   structure.addFolder(it.attribute2)
              }
              quoteProcessor.addQuoteStructure(structure)
         }
         
        Parameters:
        structure - The structure
        Returns:
      • addFolder

        public void addFolder​(String label)
        Creates and adds a new folder under the ROOT folder.

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

        Parameters:
        label - The folder label
      • addPart

        public void addPart​(String sku)
        Creates and adds a new line item to the Quote with the given sku.

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

        Parameters:
        sku - The SKU of the new part
      • build

        public QuoteBuilderResult build()
        Specified by:
        build in class AbstractBuilder