Files
alfresco-community-repo/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java
Raluca Munteanu 8674e2bfc8 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125603 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125484 slanglois: MNT-16155 Update source headers - remove old Copyrights from Java and JSP dource files


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125781 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 12:48:49 +00:00

95 lines
2.6 KiB
Java

package org.alfresco.repo.action.scheduled;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import 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
*/
public interface ScheduledActionDefinition extends InitializingBean
{
/**
* Set the template action definition that is used to build the Action to execute.
*
* @param templateActionDefinition TemplateActionDefinition
*/
public void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition);
/**
* Get the template action definition that is used to build the Action to execute.
*
* @return - the template action definition.
*/
public TemplateActionDefinition getTemplateActionDefinition();
/**
* Register with a scheduler. This should be called in the implementation afterPropertiesSet() method of InitializingBean
*
* @param scheduler Scheduler
* @throws SchedulerException
*/
public void register(Scheduler scheduler) throws SchedulerException;
/**
* Set the name of the job - used for job admin
*
* @param jobName String
*/
public void setJobName(String jobName);
/**
* Get the name of the job - used for job admin
*
* @return - the job name
*/
public String getJobName();
/**
* Set the job group - used for job admin
*
* @param jobGroup String
*/
public void setJobGroup(String jobGroup);
/**
* Get the job group - used for job admin
* @return - the job group.
*/
public String getJobGroup();
/**
* Set the trigger name - used for job admin
*
* @param triggerName String
*/
public void setTriggerName(String triggerName);
/**
* Get the trigger name - used for job admin
* @return - the trigger name.
*/
public String getTriggerName();
/**
* Set the trigger group - used for job admin
*
* @param triggerGroup String
*/
public void setTriggerGroup(String triggerGroup);
/**
* Get the trigger group - used for job admin
*
* @return - the trigger group.
*/
public String getTriggerGroup();
}