Package org.pentaho.platform.api.scheduler2

Interface IJobTrigger

All Known Subinterfaces:
IComplexJobTrigger, ICronJobTrigger, ISimpleJobTrigger
public interface IJobTrigger

  • Method Details

    • getStartTime

      Date getStartTime()
      Returns the trigger start time.
      Returns:
      the trigger start time.

    • setStartTime

      void setStartTime(Date startTime)
      Sets the trigger start time.
      Parameters:
      setStartTime - when to start the trigger. If null the trigger starts immediately.

    • getEndTime

      Date getEndTime()
      Returns the trigger end time.
      Returns:
      the trigger end time.

    • setEndTime

      void setEndTime(Date endTime)
      Sets the trigger end time.
      Parameters:
      endTime - when to end the trigger. If null the trigger runs indefinitely

    • getUiPassParam

      String getUiPassParam()
      Returns:
      the uiPassParam

    • setUiPassParam

      void setUiPassParam(String uiPassParam)
      The value of this field comes from the UI and is persisted in quartz but not used by quartz or the server. It is strictly a way for the UI to persist something. In the present implementation, this field holds the scheduleType.
      Parameters:
      uiPassParam - A User Interface provided string

    • getCronString

      String getCronString()
      Returns the Cron String used by quartz Scheduler
      Returns:
      the cronString

    • setCronString

      void setCronString(String cronString)
      Sets the cron String used by the quartz scheduler
      Parameters:
      cronString - the cronString to set

    • getDuration

      long getDuration()
      Returns:
      a long that represents in milliseconds how long this trigger should be in effect once triggered

    • setDuration

      void setDuration(long duration)
      Parameters:
      duration - Sets the length of time in milliseconds that this trigger should be in effect.

    • getStartHour

      int getStartHour()
      Returns:
      the start hour (0-23)

    • setStartHour

      void setStartHour(int startHour)
      Set the start hour (0-23)
      Parameters:
      startHour -

    • getStartMin

      int getStartMin()
      Returns:
      the start minute (0-59)

    • setStartMin

      void setStartMin(int startMin)
      Set the start minute (0-59)
      Parameters:
      startMin -

    • getStartYear

      int getStartYear()
      Returns:
      the start year (indexed from 1900 per java.util.Date)

    • setStartYear

      void setStartYear(int startYear)
      Set the start year (indexed from 1900 per java.util.Date)
      Parameters:
      startYear -

    • getStartMonth

      int getStartMonth()
      Returns:
      the start month (0-11)

    • setStartMonth

      void setStartMonth(int startMonth)
      Set the start month (0-11)
      Parameters:
      startMonth -

    • getStartDay

      int getStartDay()
      Returns:
      the start day (1-31)

    • setStartDay

      void setStartDay(int startDay)
      Set the start day (1-31)
      Parameters:
      startDay -

    • getStartAmPm

      int getStartAmPm()
      Returns:
      0 - AM; 1 - PM

    • setStartAmPm

      void setStartAmPm(int startAmPm)
      Set the AM/PM value; 0 - AM; 1 - PM
      Parameters:
      startAmPm -

    • setTimeZone

      void setTimeZone(String timeZone)
      Set the time zone (see java.util.TimeZone for valid IDs) Expects a TimeZone.
      Parameters:
      timeZone -

    • getTimeZone

      String getTimeZone()
      Returns:
      the time zone