Package net.pricefx.common.apibuilder.calculationflowaction

package net.pricefx.common.apibuilder.calculationflowaction

Builders for the actions that a Calculation Flow logic schedules.

Entry point: the actionBuilder binding variable of a Calculation Flow logic. It is a CalculationFlowActionBuilder. Each addXxxAction() call returns one action object. Set the options on that object, then call back() to add the next action.

Each action is the programmatic form of a job that the user interface also starts. Scheduling it in a logic lets the flow engine run the job unattended.

• PricelistAction calculates a Price List. Add it with actionBuilder.addPricelistAction().
• ManualPricelistAction calculates a Manual Price List. Add it with actionBuilder.addManualPricelistAction().
• LivePriceGridAction calculates a Live Price Grid (LPG), for all products or for a restricted set of products. Add it with actionBuilder.addLivePriceGridAction().
• CFSAction calculates a Calculated Field Set (CFS). Add it with actionBuilder.addCalculatedFieldSetAction().
• DataLoadAction calculates a Data Load. Add it with actionBuilder.addDataLoadAction().
• ModelCalculationAction calculates a model. It calculates every step of the model unless the logic names a single action or a subset of steps. Add it with actionBuilder.addModelCalculationAction().
• SimulationAction calculates a Simulation. Add it with actionBuilder.addSimulationAction().
• QuoteMassUpdateAction calculates a Quote Mass Update. setCopy() runs it against a copy of the object, and setSimulation() decides whether that copy is a simulation. Add it with actionBuilder.addQuoteMassUpdateAction().
• RebateRecordAction calculates the records of a Rebate Record Set. Add it with actionBuilder.addRebateRecordAction().
• ExportAction starts an export or an archiving job. Add it with actionBuilder.addExportAction().
• ObjRefAction renews the object references of a partition. Restrict it to one domain object type with setTypeCode() and to a subset with setFilter(). Add it with actionBuilder.addObjRefAction().

ScheduleSettings is not an action. It reports the schedule that the Calculation Flow configuration defines, and it can change the start date and the interval of the following runs. Obtain it with actionBuilder.getScheduleSettings().

See Also:

• Scheduled Tasks (Knowledge Base)

Classes

Class	Description
CalculationFlowActionBuilder	CalculationFlowActionBuilder is the starting point of an interface that allows you define actions within calculation flow logic.The calculation flow action builder is available in calculation flow by this call: def builder = actionBuilder Note that you will find full code snippets in the "Command Templates/Calculation Flow Examples" inside calculation flow formulas UI.
CFSAction<T extends Help>	This action starts calculation of selected CFS.
DataLoadAction<T extends Help>	This action starts calculation of selected data load.
ExportAction<T extends Help>	This action starts exporting or archiving.
LivePriceGridAction<T extends Help>	This action starts calculation of selected LPG for all skus or restricted set of skus.
ManualPricelistAction<T extends Help>	This action starts calculation of selected manual pricelist.
ModelCalculationAction<T extends Help>	If nothing is specified, all the steps of the model will be calculated.
ObjRefAction<T extends Help>	This action renews the object references of a partition.
PricelistAction<T extends Help>	This action starts calculation of selected pricelist.
QuoteMassUpdateAction<T extends Help>
RebateRecordAction<T extends Help>	This action starts calculation of selected rebate record set records.
ScheduleSettings<T extends Help>	This action is helping you to get an information about schedule as seen in the UI + if needed alter it.
SimulationAction<T extends Help>	This action starts calculation of selected simulation.