net.pricefx.common.apibuilder.clicoll

Class CalculableLineItemCollectionBuilder<T extends CalculableLineItemCollectionBuilder>

Object

ObjectIdentity

AbstractBuilder

CalculableLineItemCollectionBuilder<T>

Direct Known Subclasses:

BasicRebateAgreementBuilder, ContractBuilder, QuoteBuilder

public abstract class CalculableLineItemCollectionBuilder<T extends CalculableLineItemCollectionBuilder>
extends AbstractBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	METHOD_ADD_LINE_ITEM
static String	METHOD_ADD_OR_UPDATE_INPUT
static String	METHOD_ADD_OR_UPDATE_OUTPUT
static String	METHOD_UPDATE_FIELD
protected HeaderPhase	phase
static String	ROOT_LINE_ID

Fields inherited from class AbstractBuilder

METHOD_BUILD

Fields inherited from class ObjectIdentity

classId, idGenerator, instanceId, invocations, m, NONE, parentObjectIdentity

Constructor Summary

Constructors

Constructor and Description
CalculableLineItemCollectionBuilder(String instanceId, String classId, ObjectIdentity parentChartObjectIdentity, IdGenerator idGenerator, Invocations<MethodInvocation> invocations, HeaderPhase phase)

Method Summary

Modifier and Type	Method and Description
T	addLineItem(String key) This method adds a new line item in the root folder
T	addLineItem(String parentLineId, String key) This method adds a new line item in the specified parent (folder id)
T	addOrUpdateInput(Map<String,Object> contextParameter) This method adds or updates an input value on the root level
T	addOrUpdateInput(String lineId, Map<String,Object> contextParameter) This method adds or updates an input value on a line item
T	addOrUpdateOutput(Map<String,Object> calculationResult) This method adds or updates a result value (an output value) on the root level
T	addOrUpdateOutput(String lineId, Map<String,Object> calculationResult) This method adds or updates a result value (an output value) on a line item
boolean	isPostPhase() Determines current calculation phase of logic execution
boolean	isPrePhase() Determines current calculation phase of logic execution
T	updateField(String fieldName, Object value) Updates a header field For quotes supported fields are: additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 externalRef expiryDate editabilityStatus targetDate
T	updateField(String lineId, String fieldName, Object value) Updates a field on the line.

Methods inherited from class AbstractBuilder

build

Methods inherited from class ObjectIdentity

addInvocation, addInvocation

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

phase

protected final HeaderPhase phase

METHOD_ADD_OR_UPDATE_OUTPUT

public static final String METHOD_ADD_OR_UPDATE_OUTPUT

See Also:

Constant Field Values

METHOD_ADD_OR_UPDATE_INPUT

public static final String METHOD_ADD_OR_UPDATE_INPUT

See Also:

Constant Field Values

METHOD_UPDATE_FIELD

public static final String METHOD_UPDATE_FIELD

See Also:

Constant Field Values

METHOD_ADD_LINE_ITEM

public static final String METHOD_ADD_LINE_ITEM

See Also:

Constant Field Values

ROOT_LINE_ID

public static final String ROOT_LINE_ID

See Also:

Constant Field Values

Constructor Detail

CalculableLineItemCollectionBuilder

public CalculableLineItemCollectionBuilder(String instanceId,
                                           String classId,
                                           ObjectIdentity parentChartObjectIdentity,
                                           IdGenerator idGenerator,
                                           Invocations<MethodInvocation> invocations,
                                           HeaderPhase phase)

Method Detail

isPrePhase

public boolean isPrePhase()

Determines current calculation phase of logic execution

Returns:

true if the current context is "pre"/before line item calculation

isPostPhase

public boolean isPostPhase()

Determines current calculation phase of logic execution

Returns:

true if the current context is "post"/after line item calculation

addOrUpdateOutput

public T addOrUpdateOutput(Map<String,Object> calculationResult)

This method adds or updates a result value (an output value) on the root level

Parameters:

calculationResult - A map describing a calculation result

Returns:

itself (for flow pattern)

addOrUpdateOutput

public T addOrUpdateOutput(String lineId,
                           Map<String,Object> calculationResult)

This method adds or updates a result value (an output value) on a line item

Parameters:

lineId - The id of the line

calculationResult - A map describing a calculation result

Returns:

itself (for flow pattern)

addOrUpdateInput

public T addOrUpdateInput(Map<String,Object> contextParameter)

This method adds or updates an input value on the root level

Parameters:

calculationResult - A map describing the context parameter

Returns:

itself (for flow pattern)

addOrUpdateInput

public T addOrUpdateInput(String lineId,
                          Map<String,Object> contextParameter)

This method adds or updates an input value on a line item

Parameters:

lineId - The id of the line

calculationResult - A map describing the context parameter

Returns:

itself (for flow pattern)

updateField

public T updateField(String lineId,
                     String fieldName,
                     Object value)

Updates a field on the line. Note: Not supported for all objects e.g. quotes

Parameters:

lineId - The id of the line

fieldName - The field name

value - The new value

Returns:

itself (for flow pattern)

updateField

public T updateField(String fieldName,
                     Object value)

Updates a header field For quotes supported fields are: additionalInfo1 additionalInfo2 additionalInfo3 additionalInfo4 externalRef expiryDate editabilityStatus targetDate

Parameters:

fieldName - The field name

value - The new value

Returns:

itself (for flow pattern)

addLineItem

public T addLineItem(String key)

This method adds a new line item in the root folder

Parameters:

key - The key (usually the sku)

Returns:

itself (for flow pattern)

addLineItem

public T addLineItem(String parentLineId,
                     String key)

This method adds a new line item in the specified parent (folder id)

Parameters:

parentLineId - id of parent item

key - The key (usually the sku)

Returns: