Package net.pricefx.common.apibuilder.clicoll

package net.pricefx.common.apibuilder.clicoll

The builder and the helper that every document header logic shares.

Entry point: the binding variable of the document's header logic. Examples are quoteProcessor for a Quote and cProcessor for a Contract. Each of those objects is a CalculableLineItemCollectionBuilder. Call getHelper() on it to read the document.

• CalculableLineItemCollectionBuilder declares what a header logic can change. It adds and updates inputs and outputs, updates header fields, adds, moves and deletes line items and folders, opens and closes folders, selects and deselects items, and sets render information. switchToAsync() aborts a synchronous calculation and retries it as an asynchronous background job.
• LineItemHelper reads the document. It returns the root, finds a line item by line ID or by label, and flattens the inputs of a line item.

A header logic collects changes, it does not apply them in statement order. The builder runs the collected changes once per phase, in a fixed order. CalculableLineItemCollectionBuilder documents that order. Read it before you write a logic that both creates a line item and reads it back.

The document-specific subclasses live in the sibling quote, contract, rebateagreement, compensation and customform packages.

See Also:

• Quote Header Logic (Knowledge Base)

Class	Description
CalculableLineItemCollectionBuilder<T extends CalculableLineItemCollectionBuilder<T>>	This is the shared builder interface for Quotes, RebateAgreements, Contracts and Sales Compensation. Some important notes on the sequence in which changes to the document structure are processed: Any modifying action (adding lines, inputs, or a structure object, and so on) IS NOT executed as per sequence of the Groovy logic!
LineItemHelper	A helper interface that assists in navigating and reading a Calculable Line Item Collection (CLIC) document's line items: a Quote, Contract, Rebate Agreement, Sales Compensation, or Custom Form.
LineItemHelper.LineItem	Represents a line item, a folder, or the document root of a CLIC document (a Quote, Contract, Rebate Agreement, Sales Compensation, or Custom Form), obtained from LineItemHelper.getRoot(), LineItemHelper.findByLineId(String), LineItemHelper.findAllWithLabel(String), or LineItemHelper.LineItem.getChildren()/LineItemHelper.LineItem.getParent()/LineItemHelper.LineItem.getSiblings()/LineItemHelper.LineItem.getSubLineItems() rather than instantiated directly.
LineItemHelper.ReviewSubStep	Review sub-step information.
LineItemIterator	A closeable iterator over LineItemHelper.LineItem elements, backed either by a streaming DB cursor or by an already materialized list.
Reviewable	Implemented by helpers of document types that support a review workflow (e.g. quotes, contracts).