Package com.adobe.granite.maintenance

Interface MaintenanceTaskInfo

@ProviderType
public interface MaintenanceTaskInfo

Description of a maintenance task

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	MaintenanceTaskInfo.TaskSchedule
static class	MaintenanceTaskInfo.TaskState

Method Summary

Modifier and Type	Method	Description
java.lang.String	getConfigurationPid()
java.lang.String	getDescription()	A human readable description
MaintenanceTaskInfo.TaskState	getLastRunState()	Get the state of the last run.
java.util.Calendar	getLastRunTime()	Get the last date this task has been run.
java.util.Calendar	getLastSuccessTime()	Get the last date this task has succeeded or null.
java.lang.String	getName()	The unique name of a maintenance task.
MaintenanceTaskInfo.TaskSchedule	getSchedule()	Deprecated. Use getSuggestedSchedule()
MaintenanceTaskInfo.TaskSchedule	getSuggestedSchedule()	Get the suggested schedule.
java.lang.String	getTaskTopic()	Return the topic for the task.
java.lang.String	getTitle()	A human readable title.
boolean	isConservative()	Whether a task is conservative.
boolean	isMandatory()	Whether this task is considered to be mandatory.
boolean	isRunning()	Whether the task is currently running.
boolean	isStoppable()	Whether a task supports stopping
boolean	supportsThrottling()	Whether a task supports throttling.

Method Detail

getName

java.lang.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

java.lang.String getTitle()

A human readable title.

getDescription

java.lang.String getDescription()

A human readable description

getLastRunTime

java.util.Calendar getLastRunTime()

Get the last date this task has been run.

getLastSuccessTime

java.util.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

java.lang.String getTaskTopic()

Return the topic for the task.

isMandatory

boolean isMandatory()

Whether this task is considered to be mandatory.

getConfigurationPid

java.lang.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