Package de.espirit.firstspirit.agency

Interface MaintenanceModeAgent

public interface MaintenanceModeAgent

This agent is used to control active maintenance mode tasks.

Since:

5.2.518, 5.2.605

Field Summary

Fields

Modifier and Type	Field	Description
static final SpecialistType<MaintenanceModeAgent>	TYPE	The agent's technical type to be used for requesting the agent from a SpecialistsBroker.

Method Summary

Modifier and Type	Method	Description
@NotNull Collection<MaintenanceModeInfo>	getActiveMaintenanceModes()	A maintenance mode task is active if one of the stages mentioned in MaintenanceModeTask.MaintenanceStage is active.
void	stopMaintenanceMode(@NotNull MaintenanceModeInfo info)	Stops a maintenance mode task, skipping any future stages.

Field Details

TYPE

static final SpecialistType<MaintenanceModeAgent> TYPE

The agent's technical type to be used for requesting the agent from a SpecialistsBroker.

Since:

5.2.518, 5.2.605

Method Details

getActiveMaintenanceModes

@NotNull
@NotNull Collection<MaintenanceModeInfo> getActiveMaintenanceModes()

A maintenance mode task is active if one of the stages mentioned in MaintenanceModeTask.MaintenanceStage is active. This method returns information about all active tasks.

Returns:

a collection of all active maintenance mode tasks in no particular order. May be empty but never null.

Since:

5.2.518, 5.2.605

stopMaintenanceMode

void stopMaintenanceMode(@NotNull
 @NotNull MaintenanceModeInfo info)

Stops a maintenance mode task, skipping any future stages. If the task has been stopped or finished before, this method does nothing.

Parameters:

info - the information regarding the maintenance mode task, must not be null.

Throws:

IllegalArgumentException - if the task could not be found.

Since:

5.2.518, 5.2.605