Package net.pricefx.formulaengine.optimization

Interface ModelSchedulesContextReadOnly.ModelSchedule

Enclosing interface:
ModelSchedulesContextReadOnly
public static interface ModelSchedulesContextReadOnly.ModelSchedule
The representation of a Model Schedule accessible from a read only context.

This schedule will execute model action named getAction() at the beginning of every new getPeriod() of time starting from the date time value returned by getStartDate().

The time value of the start date is important when the period is greater or equal to one day as it will define the time of the day the model action will be executed.

Since:
11.0 Paper Plane

  • Method Details

    • getName

      String getName()
      The name of the model schedule. The name of each model schedule is unique within a given Model Object.
      Returns:
      the name of the model schedule.
      Since:
      11.0 Paper Plane

    • getPeriod

      Tuple2<Integer,ModelSchedulesContextReadOnly.PeriodUnit> getPeriod()
      Returns:
      a Tuple2 that contains as a first member the quantity of a unit of duration which is the second member of the tuple. For example: (2, PeriodUnit.DAY) represents a period of two days.
      Since:
      11.0 Paper Plane

    • getStartDate

      DateTime getStartDate()
      Returns:
      the start date and time of the model schedule. The time value of the start date is important when the period is greater or equal to one day as it will define the time of the day the model action will be executed.
      Since:
      11.0 Paper Plane

    • getAction

      String getAction()
      Returns:
      the model action name which will be executed by this model schedule.
      Since:
      11.0 Paper Plane