Package com.adobe.granite.maintenance

Interface MaintenanceTaskInfo

@ProviderType public interface MaintenanceTaskInfo
Description of a maintenance task

  • Method Details

    • getName

      String getName()
      The unique name of a maintenance task.

    • isStoppable

      boolean isStoppable()
      Whether a task supports stopping

    • isConservative

      boolean isConservative()
      Whether a task is conservative.

    • supportsThrottling

      boolean supportsThrottling()
      Whether a task supports throttling.

    • getTitle

      String getTitle()
      A human readable title.

    • getDescription

      String getDescription()
      A human readable description

    • getLastRunTime

      Calendar getLastRunTime()
      Get the last date this task has been run.

    • getLastSuccessTime

      Calendar getLastSuccessTime()
      Get the last date this task has succeeded or null. See MaintenanceTaskInfo.TaskState.SUCCEEDED

    • getLastRunState

      MaintenanceTaskInfo.TaskState getLastRunState()
      Get the state of the last run.

    • isRunning

      boolean isRunning()
      Whether the task is currently running.

    • getSchedule

      @Deprecated MaintenanceTaskInfo.TaskSchedule getSchedule()
      Deprecated.
      Use getSuggestedSchedule()
      This method always returns MaintenanceTaskInfo.TaskSchedule.DAILY

    • getSuggestedSchedule

      MaintenanceTaskInfo.TaskSchedule getSuggestedSchedule()
      Get the suggested schedule.
      Returns:
      The suggested schedule or null

    • getTaskTopic

      String getTaskTopic()
      Return the topic for the task.

    • isMandatory

      boolean isMandatory()
      Whether this task is considered to be mandatory.

    • getConfigurationPid

      String getConfigurationPid()
      Returns:
      - the task's configuration PID, to be used for configuration through the UI. The method returns null if there's any problem with retrieving the PID