Package org.ametys.core.schedule

Interface Schedulable

All Known Implementing Classes:
AbstractCollectionSchedulable, AbstractDeleteFilesSchedulable, AbstractRebuildLiveWorkspaceSchedulable, AbstractReportSchedulable, AbstractSendingMailSchedulable, AbstractSendNotificationSummarySchedulable, AbstractStaticSchedulable, AlertSchedulable, AlertSchedulable, AlertSchedulable, ApogeeSchedulable, ArchiveContentsSchedulable, ArchiveContentsSchedulable, ArchiveEducationalBookletSchedulable, ArchiveEducationalBookletSchedulable, AutomaticNewslettersSchedulable, CacheMonitoringSchedulable, CatalogPDFExportSchedulable, CatalogPDFExportSchedulable, CheckContentConsistencySchedulable, CheckContentConsistencySchedulable, CleanCacheSchedulable, CleanFSUploadSchedulable, CleanJCaptchaSchedulable, ComputeProgramSkillsSchedulable, ComputeProgramSkillsSchedulable, ContentExportSchedulable, CopyCatalogSchedulable, CoursePartPurgeSchedulable, DeleteCatalogSchedulable, DeleteClassifiedAdsSchedulable, DeleteEducationalBookletSchedulable, DeleteExtractionsSchedulable, DeleteReportsSchedulable, DuplicateContentsDetectionSchedulable, DuplicateContentsDetectionSchedulable, EducationalBookletSchedulable, EducationalBookletSchedulable, EmptyCollectionSchedulable, ExecuteExtractionSchedulable, ExportArchiveSchedulable, ExportSchedulable, FrontCacheMonitoringSchedulable, GlobalValidationSchedulable, GlobalWorkspaceIndexerSchedulable, ImportArchiveSchedulable, IndexContentSchedulable, InvalidateFOCacheSchedulable, MaintenanceSchedulable, MCCValidatedPDFSchedulable, OdfRefTableDataSynchronizationSchedulable, OrgUnitConsistencyExtractSchedulable, OrgUnitMCCDiffReportSchedulable, OrgUnitMCCReportSchedulable, OrgUnitReportSchedulable, ProgramConsistencyExtractSchedulable, ProgramMCCReportSchedulable, ProgramReportSchedulable, PublishOrUnpublishPageSchedulable, PurgeContentsSchedulable, RebuildContentsWithoutSiteLiveWorkspaceSchedulable, RebuildLiveAllWorkspaceSchedulable, RebuildLiveSiteWorkspaceSchedulable, ReindexMembersSchedulable, ReloadSolrAclCacheSchedulable, ReloadSolrAclCachesForCoresSchedulable, RRDsFeederSchedulable, ScriptSchedulable, SendDailyNotificationSummarySchedulable, SendInvitationsSchedulable, SendMailSchedulable, SendMonthlyNotificationSummarySchedulable, SendWeeklyNotificationSummarySchedulable, ServersSynchronizationSchedulable, SiteIndexerSchedulable, SolrExportSchedulable, StatisticsSchedulable, SynchronizeAllCollectionsSchedulable, SynchronizeCollectionSchedulable, UnlockSchedulable
public interface Schedulable
This interface represents a 'job' which can be performed and scheduled.

  • Method Details

    • execute

      void execute(JobExecutionContext context, ContainerProgressionTracker progressionTracker) throws Exception
      The action to perform when a trigger is fired. Do not manually call this method.
      Parameters:
      context - the context
      progressionTracker - The progression tracker
      Throws:
      Exception - if an error occurred

    • 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

    • getProgressionTracker

      ProgressionTracker getProgressionTracker(JobExecutionContext context)
      Get the description of the current step
      Parameters:
      context - The context
      Returns:
      The description of the current step

    • 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,ElementDefinition> getParameters()
      Get the parameters for job execution
      Returns:
      the parameters