Class ModelCalculationAction<T extends Help>
Object
Action
ModelCalculationAction<T>
- All Implemented Interfaces:
Help
public final class ModelCalculationAction<T extends Help>
extends Action
If nothing is specified, all the steps of the model will be calculated.
If both action and steps are specified, then only the action will be executed.
-
Field Summary
Fields inherited from class Action
jobs
-
Constructor Summary
ConstructorDescriptionModelCalculationAction
(T backLink, Invocations<MethodInvocationRecord> invocations, String modelUniqueName) -
Method Summary
Modifier and TypeMethodDescriptionExecute one of the actions declared in theModelObject
'sModelClass
.allSteps()
Sets the calculation range of the model to all steps (setsfromStep
andtoStep
to null).back()
Sets the calculation range of steps of the specified model, beginning with the first step (included).Sets the calculation range of steps of the specified model, beginning with the specified step (included).boolean
Calculates the step of the model.setCalculate
(Boolean calculate) Whether the action is valid and should be triggered or not.Sets the calculation range of steps of the specified model, ending with the last step (included).Sets the calculation range of steps of the specified model, ending with the specified step (included).toString()
-
Constructor Details
-
ModelCalculationAction
-
-
Method Details
-
action
Execute one of the actions declared in theModelObject
'sModelClass
.- Since:
- 10.3 Bee's Knees
-
allSteps
Sets the calculation range of the model to all steps (setsfromStep
andtoStep
to null).Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .allSteps() .setCalculate(true) return
- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
oneStep
Calculates the step of the model.Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .oneStep("stepName") .setCalculate(true) return
- Parameters:
step
- the step to be calculated- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
fromFirstStep
Sets the calculation range of steps of the specified model, beginning with the first step (included). SetsfromStep
to null. Used together withtoStep(String)
.Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .fromFirstStep() .toStep("StepName3") .setCalculate(true) return
- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
fromStep
Sets the calculation range of steps of the specified model, beginning with the specified step (included). Used together withtoStep(String)
ortoLastStep()
.Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .fromStep("StepName2") .toStep("StepName3") .setCalculate(true) return
- Parameters:
step
- the name of the step to start the calculation with- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
toLastStep
Sets the calculation range of steps of the specified model, ending with the last step (included). SetstoStep
to null. Used together withfromStep(String)
.Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .fromStep("StepName2") .toLastStep() .setCalculate(true) return
- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
toStep
Sets the calculation range of steps of the specified model, ending with the specified step (included). Used together withfromStep(String)
orfromFirstStep()
()}.Example:
actionBuilder.addModelCalculationAction("modelUniqueName") .fromStep("StepName2") .toStep("StepName3") .setCalculate(true) return
- Parameters:
step
- the name of the step to end the calculation with- Returns:
- the instance of
ModelCalculationAction
- Since:
- 10.1 - Bee's Knees
- See Also:
-
setCalculate
Whether the action is valid and should be triggered or not.- Parameters:
calculate
-- true - calculation of the model is started as background process
- false - calculation of the model is NOT started at all
-
back
-
getObjectName
-
getModelUniqueName
-
getCalculate
public boolean getCalculate() -
getFromStep
-
getToStep
-
getAction
-
toString
-