Package net.pricefx.common.apibuilder.customform

Class CustomFormCollectionBuilder

Object

ObjectIdentity

AbstractBuilder

CalculableLineItemCollectionBuilder<CustomFormCollectionBuilder>

CustomFormCollectionBuilder

public class CustomFormCollectionBuilder
extends CalculableLineItemCollectionBuilder<CustomFormCollectionBuilder>

CustomFormCollectionBuilder is the starting point of an interface that allows you to manipulate a custom form object in a custom form header calculation logic.
The header calculation is executed twice: Once as 'pre phase' and once after that as 'post phase'.
Use isPrePhase() and isPostPhase() methods to detect the current phase.
The custom form builder is available in the header logic by this call:
def processor = customFormProcessor

IMPORTANT: Please read super class notes on the sequence of execution!

Field Summary

Fields inherited from class CalculableLineItemCollectionBuilder

METHOD_ADD_LINE_ITEM, METHOD_ADD_OR_UPDATE_INPUT, METHOD_ADD_OR_UPDATE_OUTPUT, METHOD_UPDATE_FIELD, phase, 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	Description
CustomFormCollectionBuilder(String instanceId, String classId, IdGenerator idGenerator, Invocations<MethodInvocation> invocations, Map<String,Object> view, HeaderPhase phase)

Method Summary

Modifier and Type	Method	Description
CustomFormBuilderResult	build()	Creates an instance of CustomFormBuilderResult with the invocations accumulated in this builder instance
LineItemHelper	getHelper()	Gets a helper class that assists in manipulating the custom form

Methods inherited from class CalculableLineItemCollectionBuilder

addLineItem, addLineItem, addLineItem, addOrUpdateInput, addOrUpdateInput, addOrUpdateOutput, addOrUpdateOutput, clearRenderInfo, deleteItem, isPostPhase, isPrePhase, moveItem, renameFolder, setRenderInfo, updateField, updateField

Methods inherited from class ObjectIdentity

addInvocation, addInvocation

Methods inherited from class Object

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

Constructor Details

CustomFormCollectionBuilder

public CustomFormCollectionBuilder(String instanceId,
 String classId,
 IdGenerator idGenerator,
 Invocations<MethodInvocation> invocations,
 Map<String,Object> view,
 HeaderPhase phase)

Method Details

build

public CustomFormBuilderResult build()

Creates an instance of CustomFormBuilderResult with the invocations accumulated in this builder instance

Specified by:

build in class AbstractBuilder

Returns:

a CustomFormBuilderResult instance

getHelper

public LineItemHelper getHelper()

Gets a helper class that assists in manipulating the custom form

Returns:

The helper object