public interface MaintenanceModeInfo
MaintenanceModeTask
.Modifier and Type | Method and Description |
---|---|
MaintenanceModeTask.ConcurrentTaskHandling |
getConcurrentTaskHandling()
Indicates if other tasks may be executed while the maintenance mode is active.
|
MaintenanceModeTask.MaintenanceStage |
getCurrentStage()
A maintenance mode task consists of up to five stages, from an initial preparation
period up to activating the actual maintenance mode.
|
String |
getDescription()
The description of this maintenance mode.
|
MaintenanceModeTask.DisconnectMode |
getDisconnectMode()
Indicates the handling of existing sessions once the stage
MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE
begins. |
long |
getDurationOfStageInMillis(MaintenanceModeTask.MaintenanceStage stage)
Each stage has a duration after which the next stage is started.
|
long |
getId()
The automatically assigned, internal id.
|
MaintenanceModeTask.MaintenanceScope |
getMaintenanceScope()
Indicates the scope of this maintenance task, i.e. if only certain
projects or the whole server is affected.
|
String |
getMessage()
The message which is displayed to all users once the task has
been started.
|
MaintenanceModeTask.MessageDisplayType |
getMessageDisplayType()
Indicates how the message is displayed to the users.
|
List<Long> |
getProjectIds()
All projects affected by the maintenance task.
|
long |
getScheduleEntryId()
The id of the related schedule entry.
|
ZonedDateTime |
getStartingTimeOfStage(MaintenanceModeTask.MaintenanceStage stage)
Each
MaintenanceModeTask.MaintenanceStage is started at a particular time if the task is not stopped prematurely. |
Date |
getStartingTimeOfStageAsDate(MaintenanceModeTask.MaintenanceStage stage)
Deprecated.
since 5.2.180703 - use
#getStartingTimeOfStage(MaintenanceStage) instead |
Optional<Duration> |
remainingDurationOfCurrentStage()
This method may be used to determine the remaining duration of the currently
active stage.
|
long |
remainingDurationOfCurrentStageInMillis()
Deprecated.
since 5.2.180703 - use
remainingDurationOfCurrentStage() instead |
long getId()
long getScheduleEntryId()
ScheduleStorage.getScheduleEntry(long)
@NotNull String getDescription()
null
.@NotNull String getMessage()
null
.@Nullable MaintenanceModeTask.MaintenanceStage getCurrentStage()
null
if the maintenance
mode has been completed or stopped.
Optional<Duration> remainingDurationOfCurrentStage()
Optional
if the maintenance mode has been finished or stopped.@Deprecated long remainingDurationOfCurrentStageInMillis()
remainingDurationOfCurrentStage()
instead@Deprecated @NotNull Date getStartingTimeOfStageAsDate(@NotNull MaintenanceModeTask.MaintenanceStage stage)
#getStartingTimeOfStage(MaintenanceStage)
insteadMaintenanceModeTask.MaintenanceStage
is started at a particular time if the task is not stopped prematurely.
This method returns the estimated starting time for future stages and past starting times
for previous stages.stage
- The stage for which the starting time should be returned, must not be null
.null
.@NotNull ZonedDateTime getStartingTimeOfStage(@NotNull MaintenanceModeTask.MaintenanceStage stage)
MaintenanceModeTask.MaintenanceStage
is started at a particular time if the task is not stopped prematurely.
This method returns the estimated starting time for future stages and past starting times
for previous stages.stage
- The stage for which the starting time should be returned, must not be null
.null
.@NotNull MaintenanceModeTask.MessageDisplayType getMessageDisplayType()
null
.@NotNull MaintenanceModeTask.DisconnectMode getDisconnectMode()
MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE
begins.null
.@NotNull MaintenanceModeTask.MaintenanceScope getMaintenanceScope()
null
.@NotNull MaintenanceModeTask.ConcurrentTaskHandling getConcurrentTaskHandling()
null
.long getDurationOfStageInMillis(@NotNull MaintenanceModeTask.MaintenanceStage stage)
stage
- the stage for which to query the duration, must not be null
.@NotNull List<Long> getProjectIds()
null
.IllegalStateException
- if the scope is MaintenanceModeTask.MaintenanceScope.GLOBAL
getMaintenanceScope()
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210