Package net.pricefx.common.apibuilder.calculationflowaction

Class SimulationAction<ATTACHEDTO extends Help>

Object

Action

SimulationAction<ATTACHEDTO>

All Implemented Interfaces:

Help

public class SimulationAction<ATTACHEDTO extends Help>
extends Action

This action starts calculation of selected simulation. It's a programmatic version of the same action available in UI. As such it allows user to schedule the action in calculation flow formula.

Field Summary

Fields inherited from class Action

jobs

Constructor Summary

Constructors

Constructor	Description
SimulationAction(ATTACHEDTO backLink, Invocations<MethodInvocationRecord> invocations, String simulationLabel)

Method Summary

Modifier and Type	Method	Description
ATTACHEDTO	back()
Boolean	getCalculate()
int	getDistributedCalculationThreshold()
List<ChainedJobInfo>	getNextJobs()
String	getObjectName()
int	getPriority()
String	getSimulationLabel()
SimulationAction<ATTACHEDTO>	setCalculate(Boolean calculate)	Whether the action is valid and should be triggered or not.
SimulationAction<ATTACHEDTO>	setDistributedCalculationThreshold(int threshold)	Sets a job-individual threshold to start a distributed calculation.
SimulationAction<ATTACHEDTO>	setNextJobs(List<ChainedJobInfo> jobs)	Defines subsequent follow-on jobs
SimulationAction<ATTACHEDTO>	setPriority(int priority)	Sets the prority of this job.
String	toString()

Methods inherited from class Object

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

Constructor Detail

SimulationAction

public SimulationAction(ATTACHEDTO backLink,
                        Invocations<MethodInvocationRecord> invocations,
                        String simulationLabel)

Method Detail

setCalculate

public SimulationAction<ATTACHEDTO> setCalculate(Boolean calculate)

Whether the action is valid and should be triggered or not.

Parameters:

calculate -

• true - calculation of the simulation is started as background process
• false - calculation of the simulation is NOT started at all

setPriority

public SimulationAction<ATTACHEDTO> setPriority(int priority)

Sets the prority of this job.

Parameters:

priority - Default is 0 (lowest user-definable priority). Max value is 9.

Returns:

setDistributedCalculationThreshold

public SimulationAction<ATTACHEDTO> setDistributedCalculationThreshold(int threshold)

Sets a job-individual threshold to start a distributed calculation. Please note: Any values below 1000 may very well be counter-productive and make the job slower!

Parameters:

threshold - The number of items that need to be part of the job in order to execute it in distributed mode.

Returns:

back

public ATTACHEDTO back()

setNextJobs

public SimulationAction<ATTACHEDTO> setNextJobs(List<ChainedJobInfo> jobs)

Defines subsequent follow-on jobs

Parameters:

jobs - List of ChainedJobInfo objects

Returns:

getObjectName

public String getObjectName()

getSimulationLabel

public String getSimulationLabel()

getCalculate

public Boolean getCalculate()

getPriority

public int getPriority()

getDistributedCalculationThreshold

public int getDistributedCalculationThreshold()

getNextJobs

public List<ChainedJobInfo> getNextJobs()

toString

public String toString()

Overrides:

toString in class Object