org.ametys.core.schedule

Interface Schedulable

All Known Implementing Classes:

AbstractRebuildLiveWorkspaceSchedulable, AbstractStaticSchedulable, GlobalWorkspaceIndexerSchedulable, PublishOrUnpublishPageSchedulable, RebuildLiveAllWorkspaceSchedulable, RebuildLiveSiteWorkspaceSchedulable, ScriptSchedulable, SendMailSchedulable, SiteIndexerSchedulable, SynchronizeAllCollectionsSchedulable, SynchronizeCollectionSchedulable, UnlockSchedulable

public interface Schedulable

This interface represents a 'job' which can be performed and scheduled.

Method Summary

Modifier and Type	Method and Description
boolean	acceptConcurrentExecution() Returns true if two runnables of this schedulable can be executed concurrently
void	execute(JobExecutionContext context) The action to perform when a trigger is fired.
I18nizableText	getDescription() Return the description
String	getIconGlyph() Returns the glyph icon
String	getIconLarge() Returns the path to the large icon in 48x48 pixels
String	getIconMedium() Returns the path to the medium icon in 32x32 pixels
String	getIconSmall() Returns the path to the small icon in 16x16 pixels
String	getId() Returns the id
I18nizableText	getLabel() Returns the label
Map<String,Parameter<ParameterHelper.ParameterType>>	getParameters() Get the parameters for job execution
boolean	isPrivate() Returns true if the schedulable is private

Method Detail

execute

void execute(JobExecutionContext context)
      throws Exception

The action to perform when a trigger is fired. Do not manually call this method.

Parameters:

context - the context

Throws:

Exception - if an error occured

getId

String getId()

Returns the id

Returns:

the id

getLabel

I18nizableText getLabel()

Returns the label

Returns:

the i18n label

getDescription

I18nizableText getDescription()

Return the description

Returns:

the i18n description

getIconGlyph

String getIconGlyph()

Returns the glyph icon

Returns:

the glyph icon

getIconSmall

String getIconSmall()

Returns the path to the small icon in 16x16 pixels

Returns:

the path to the 16x16 icon

getIconMedium

String getIconMedium()

Returns the path to the medium icon in 32x32 pixels

Returns:

the path to the 32x32 icon

getIconLarge

String getIconLarge()

Returns the path to the large icon in 48x48 pixels

Returns:

the path to the 48x48 icon

isPrivate

boolean isPrivate()

Returns true if the schedulable is private

Returns:

true if the schedulable is private

acceptConcurrentExecution

boolean acceptConcurrentExecution()

Returns true if two runnables of this schedulable can be executed concurrently

Returns:

true if two runnables of this schedulable can be executed concurrently

getParameters

Map<String,Parameter<ParameterHelper.ParameterType>> getParameters()

Get the parameters for job execution

Returns:

the parameters