Package net.pricefx.common.apibuilder.clicoll

Interface LineItemHelper

All Known Subinterfaces:

CompensationHelper, ContractHelper, QuoteHelper, QuotePersistedHelper, RebateAgreementHelper

public interface LineItemHelper

Base helper interface for manipulating a Calculable Line Item Collection (quote / contract / rebate agreement / compensation) document map.

See Also:

• LineItemHelper.LineItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LineItemHelper.LineItem	Represents either a line item or a folder of a document (e.g. quote/contract/rebate).
static final record	LineItemHelper.ReviewSubStep	Review sub-step information.

Method Summary

Modifier and Type	Method	Description
List<LineItemHelper.LineItem>	findAllWithLabel(String label)
LineItemHelper.LineItem	findByLineId(String lineItemId)
static List<Map<String,Object>>	getFlattedInputs(List<Map<String,Object>> inputs)	Flattens a list of (possibly nested) inputs into a single flat list.
LineItemHelper.LineItem	getRoot()
LineItemHelper.LineItem	lineItemFromMap(Map<String,Object> lineItemMap)	Creates the line item object from the given map.

Method Details

getFlattedInputs

static List<Map<String,Object>> getFlattedInputs(List<Map<String,Object>> inputs)

Flattens a list of (possibly nested) inputs into a single flat list.

Parameters:

inputs - the inputs to flatten (may be null)

Returns:

a flat list of inputs (never null)

lineItemFromMap

LineItemHelper.LineItem lineItemFromMap(Map<String,Object> lineItemMap)

Creates the line item object from the given map. The structure of the map can be found, for example, in the result of quoteProcessor.getQuoteView().

Parameters:

lineItemMap - the line item map

Returns:

the line item

findByLineId

LineItemHelper.LineItem findByLineId(String lineItemId)

Parameters:

lineItemId - the line id (or "ROOT")

Returns:

the line item with the given id, or null if not found

getRoot

LineItemHelper.LineItem getRoot()

Returns:

the ROOT folder (the header level)

findAllWithLabel

List<LineItemHelper.LineItem> findAllWithLabel(String label)

Parameters:

label - the tree label to search for

Returns:

all line items / folders with the given label