org.alfresco.repo.action.scheduled

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.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getJobGroup() Get the job group - used for job admin
java.lang.String	getJobName() Get the name of the job - used for job admin
TemplateActionDefinition	getTemplateActionDefinition() Get the template action definition that is used to build the Action to execute.
java.lang.String	getTriggerGroup() Get the trigger group - used for job admin
java.lang.String	getTriggerName() Get the trigger name - used for job admin
void	register(org.quartz.Scheduler scheduler) Register with a scheduler.
void	setJobGroup(java.lang.String jobGroup) Set the job group - used for job admin
void	setJobName(java.lang.String jobName) Set the name of the job - used for job admin
void	setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition) Set the template action definition that is used to build the Action to execute.
void	setTriggerGroup(java.lang.String triggerGroup) Set the trigger group - used for job admin
void	setTriggerName(java.lang.String triggerName) Set the trigger name - used for job admin

Methods inherited from interface org.springframework.beans.factory.InitializingBean

afterPropertiesSet

Method Detail

setTemplateActionDefinition

void setTemplateActionDefinition(TemplateActionDefinition templateActionDefinition)

Set the template action definition that is used to build the Action to execute.

Parameters:

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 -

Throws:

org.quartz.SchedulerException

setJobName

void setJobName(java.lang.String jobName)

Set the name of the job - used for job admin

Parameters:

jobName -

getJobName

java.lang.String getJobName()

Get the name of the job - used for job admin

Returns:

- the job name

setJobGroup

void setJobGroup(java.lang.String jobGroup)

Set the job group - used for job admin

Parameters:

jobGroup -

getJobGroup

java.lang.String getJobGroup()

Get the job group - used for job admin

Returns:

- the job group.

setTriggerName

void setTriggerName(java.lang.String triggerName)

Set the trigger name - used for job admin

Parameters:

triggerName -

getTriggerName

java.lang.String getTriggerName()

Get the trigger name - used for job admin

Returns:

- the trigger name.

setTriggerGroup

void setTriggerGroup(java.lang.String triggerGroup)

Set the trigger group - used for job admin

Parameters:

triggerGroup -

getTriggerGroup

java.lang.String getTriggerGroup()

Get the trigger group - used for job admin

Returns:

- the trigger group.