Package org.apache.tapestry5.ioc.services.cron

# Interface PeriodicExecutor

All Known Implementing Classes:
  `PeriodicExecutorImpl`

public interface PeriodicExecutor
A service that executes a job at intervals specified by a `Schedule`.

Since:
  5.3

- ## Method Summary

  Modifier and Type
  Method
  Description
  `PeriodicJob`
  `addJob(Schedule schedule, String name, Runnable job)`
  Adds a job to be executed.
  `void`
  `init()`
  Initializes this service.

- ## Method Details

  - ### addJob

    PeriodicJob addJob(Schedule schedule, String name, Runnable job)
    Adds a job to be executed. The job is executed in a thread pool (via `ParallelExecutor.invoke(org.apache.tapestry5.ioc.Invokable)`), as determined by the schedule.
    Parameters:
      `schedule` - defines when the job will next execute
      `name` - a name used in debugging output related to the job
      `job` - a Runnable object that represents the work to be done
    Returns:
      a PeriodicJob that can be used to query when the job executes, or to cancel its execution

  - ### init

    void init()
    Initializes this service. Never call this method direclty. It's intended for internal Tapestry-IoC usage only.