Interface ScheduledActionDefinition

All Superinterfaces:
org.springframework.beans.factory.InitializingBean
All Known Implementing Classes:
AbstractScheduledAction, CronScheduledQueryBasedTemplateActionDefinition

public interface ScheduledActionDefinition extends org.springframework.beans.factory.InitializingBean
The information needed to schedule a job. The implementation is responsible for creating job details, triggers and registering with a scheduler. This is not used anywhere at the moment. When we have a service then scheduled actions will be registered with the service.
Author:
Andy Hind
  • Method Details

    • setTemplateActionDefinition

      void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition)
      Set the template action definition that is used to build the Action to execute.
      Parameters:
      templateActionDefinition - TemplateActionDefinition
    • getTemplateActionDefinition

      TemplateActionDefinition getTemplateActionDefinition()
      Get the template action definition that is used to build the Action to execute.
      Returns:
      - the template action definition.
    • register

      void register(org.quartz.Scheduler scheduler) throws org.quartz.SchedulerException
      Register with a scheduler. This should be called in the implementation afterPropertiesSet() method of InitializingBean
      Parameters:
      scheduler - Scheduler
      Throws:
      org.quartz.SchedulerException
    • setJobName

      void setJobName(String jobName)
      Set the name of the job - used for job admin
      Parameters:
      jobName - String
    • getJobName

      String getJobName()
      Get the name of the job - used for job admin
      Returns:
      - the job name
    • setJobGroup

      void setJobGroup(String jobGroup)
      Set the job group - used for job admin
      Parameters:
      jobGroup - String
    • getJobGroup

      String getJobGroup()
      Get the job group - used for job admin
      Returns:
      - the job group.
    • setTriggerName

      void setTriggerName(String triggerName)
      Set the trigger name - used for job admin
      Parameters:
      triggerName - String
    • getTriggerName

      String getTriggerName()
      Get the trigger name - used for job admin
      Returns:
      - the trigger name.
    • setTriggerGroup

      void setTriggerGroup(String triggerGroup)
      Set the trigger group - used for job admin
      Parameters:
      triggerGroup - String
    • getTriggerGroup

      String getTriggerGroup()
      Get the trigger group - used for job admin
      Returns:
      - the trigger group.