Package de.espirit.firstspirit.access.store

Interface RestoreProgress

All Superinterfaces:

ActionProgress, Serializable

public interface RestoreProgress
extends ActionProgress

Interface providing access to the progress information of a server restore action.

Since:

4.0.57

See Also:

• AccessUtil.restore(IDProvider, ElementInfo, boolean, boolean, boolean)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	RestoreProgress.ProblemType	The problem type.

Method Summary

Modifier and Type	Method	Description
Map<Object,Store.Type>	getMissingOutgoingReferences()	Returns a map containing all referenced elements which could not be found, mapped from object key to store type.
Set<Long>	getMissingPermissionElements()	Returns a set of ids of all elements which couldn't be restored due to missing permissions.
EnumMap<RestoreProgress.ProblemType,Set<Long>>	getProblematicElements()	Returns a map containing all elements which would cause problem during restore process.
Set<Long>	getRestoredElements()	Returns a set of ids of all elements which were restored during restore process.
boolean	isCheckOnlyMode()	Returns true if the server action was started in 'check-only' mode. If the server action runs in 'check-only' mode the whole process is only tested, but the involved elements will not be restored.

Methods inherited from interface de.espirit.firstspirit.access.ActionProgress

getLog, getProgress, getStatus, isFinished

Method Details

getRestoredElements

Set<Long> getRestoredElements()

Returns a set of ids of all elements which were restored during restore process.

Returns:

A set of element ids.

Since:

4.0.57

getMissingOutgoingReferences

Map<Object,Store.Type> getMissingOutgoingReferences()

Returns a map containing all referenced elements which could not be found, mapped from object key to store type.

Returns:

A map containing all referenced elements which could not be found.

Since:

4.0.128

getMissingPermissionElements

Set<Long> getMissingPermissionElements()

Returns a set of ids of all elements which couldn't be restored due to missing permissions.

Returns:

A set of element ids.

Since:

4.0.57

getProblematicElements

EnumMap<RestoreProgress.ProblemType,Set<Long>> getProblematicElements()

Returns a map containing all elements which would cause problem during restore process.

Returns:

A map containing all elements which would cause problem during restore process.

Since:

4.0.57

isCheckOnlyMode

boolean isCheckOnlyMode()

Returns true if the server action was started in 'check-only' mode.
If the server action runs in 'check-only' mode the whole process is only tested, but the involved elements will not be restored.

Returns:

true if the server action was started in 'check-only' mode.

Since:

4.0.57