Files
alfresco-community-repo/source/java/org/alfresco/repo/action/scheduled/ScheduledActionDefinition.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

120 lines
3.6 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
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();
}