Package net.pricefx.common.apibuilder.calculationflowaction

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

Constructors

Constructor	Description
ModelCalculationAction(T backLink, Invocations<MethodInvocationRecord> invocations, String modelUniqueName)

Method Summary

Modifier and Type	Method	Description
ModelCalculationAction<T>	action(String actionName)	Execute one of the actions declared in the ModelObject's ModelClass.
ModelCalculationAction<T>	allSteps()	Sets the calculation range of the model to all steps (sets fromStep and toStep to null).
T	back()
ModelCalculationAction<T>	fromFirstStep()	Sets the calculation range of steps of the specified model, beginning with the first step (included).
ModelCalculationAction<T>	fromStep(String step)	Sets the calculation range of steps of the specified model, beginning with the specified step (included).
String	getAction()
boolean	getCalculate()
Optional<String>	getFromStep()
String	getModelUniqueName()
String	getObjectName()
Optional<String>	getToStep()
ModelCalculationAction<T>	oneStep(String step)	Calculates the step of the model.
ModelCalculationAction<T>	setCalculate(Boolean calculate)	Whether the action is valid and should be triggered or not.
ModelCalculationAction<T>	toLastStep()	Sets the calculation range of steps of the specified model, ending with the last step (included).
ModelCalculationAction<T>	toStep(String step)	Sets the calculation range of steps of the specified model, ending with the specified step (included).
String	toString()

Methods inherited from class Object

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

Constructor Details

ModelCalculationAction

public ModelCalculationAction(T backLink,
 Invocations<MethodInvocationRecord> invocations,
 String modelUniqueName)

Method Details

action

public ModelCalculationAction<T> action(String actionName)

Execute one of the actions declared in the ModelObject's ModelClass.

Since:

10.3 Bee's Knees

allSteps

public ModelCalculationAction<T> allSteps()

Sets the calculation range of the model to all steps (sets fromStep and toStep to null).

Example:

 actionBuilder.addModelCalculationAction("modelUniqueName")
          .allSteps()
          .setCalculate(true)
 return
 

Returns:

the instance of ModelCalculationAction

Since:

10.1 - Bee's Knees

See Also:

• Model Class (MC) Knowledge Base article

oneStep

public ModelCalculationAction<T> oneStep(String step)

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:

• Model Class (MC) Knowledge Base article

fromFirstStep

public ModelCalculationAction<T> fromFirstStep()

Sets the calculation range of steps of the specified model, beginning with the first step (included). Sets fromStep to null. Used together with toStep(String).

Example:

 actionBuilder.addModelCalculationAction("modelUniqueName")
          .fromFirstStep()
          .toStep("StepName3")
          .setCalculate(true)
 return
 

Returns:

the instance of ModelCalculationAction

Since:

10.1 - Bee's Knees

See Also:

• Model Class (MC) Knowledge Base article

fromStep

public ModelCalculationAction<T> fromStep(String step)

Sets the calculation range of steps of the specified model, beginning with the specified step (included). Used together with toStep(String) or toLastStep().

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:

• Model Class (MC) Knowledge Base article

toLastStep

public ModelCalculationAction<T> toLastStep()

Sets the calculation range of steps of the specified model, ending with the last step (included). Sets toStep to null. Used together with fromStep(String).

Example:

 actionBuilder.addModelCalculationAction("modelUniqueName")
          .fromStep("StepName2")
          .toLastStep()
          .setCalculate(true)
 return
 

Returns:

the instance of ModelCalculationAction

Since:

10.1 - Bee's Knees

See Also:

• Model Class (MC) Knowledge Base article

toStep

public ModelCalculationAction<T> toStep(String step)

Sets the calculation range of steps of the specified model, ending with the specified step (included). Used together with fromStep(String) or fromFirstStep() ()}.

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:

• Model Class (MC) Knowledge Base article

setCalculate

public ModelCalculationAction<T> setCalculate(Boolean calculate)

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

public T back()

getObjectName

public String getObjectName()

getModelUniqueName

public String getModelUniqueName()

getCalculate

public boolean getCalculate()

getFromStep

public Optional<String> getFromStep()

getToStep

public Optional<String> getToStep()

getAction

public String getAction()

toString

public String toString()

Overrides:

toString in class Object