org.xwiki.extension.job.plan

Interface ExtensionPlanAction

public interface ExtensionPlanAction

An action to perform as part of an extension plan.

Since:

4.0M1

Version:

$Id: cf0e598a8b8a732f44705a887916cfcf67e0f532 $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ExtensionPlanAction.Action The action to execute.

Method Summary

Modifier and Type	Method and Description
ExtensionPlanAction.Action	getAction()
Extension	getExtension()
String	getNamespace()
InstalledExtension	getPreviousExtension() Deprecated. since 5.0RC1 used getPreviousExtensions() instead
Collection<InstalledExtension>	getPreviousExtensions()
default Extension	getRewrittenExtension()
boolean	isDependency()

Method Detail

getExtension

Extension getExtension()

Returns:

the extension on which to perform the action

getRewrittenExtension

default Extension getRewrittenExtension()

Returns:

the result of ExtensionRewriter.rewrite(Extension) on the extension on which to perform the action

Since:

8.4.2, 9.0RC1

getPreviousExtension

@Deprecated
InstalledExtension getPreviousExtension()

Deprecated. since 5.0RC1 used getPreviousExtensions() instead

Returns:

the currently installed extension. Used when upgrading.

getPreviousExtensions

Collection<InstalledExtension> getPreviousExtensions()

Returns:

the currently installed extensions. Used when upgrading.

getAction

ExtensionPlanAction.Action getAction()

Returns:

the action to perform

getNamespace

String getNamespace()

Returns:

the namespace in which the action should be executed

isDependency

boolean isDependency()

Returns:

indicate indicate if the extension is a dependency of another one only in the plan