Package org.ametys.web.administration.welcome

Class WelcomeStepExtensionPoint

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint<WelcomeStep>

org.ametys.web.administration.welcome.WelcomeStepExtensionPoint

All Implemented Interfaces:

LogEnabled, ExtensionPoint<WelcomeStep>, Disposable, Initializable, Component, Contextualizable, Serviceable, ThreadSafe

public class WelcomeStepExtensionPoint
extends AbstractThreadSafeComponentExtensionPoint<WelcomeStep>

ExtensionPoint handling the steps of the Admin welcome feature.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

_cocoonManager, _context, _manager

Constructor Summary

Constructors

Constructor	Description
WelcomeStepExtensionPoint()

Method Summary

Modifier and Type	Method	Description
int	getCurrentStep()	Gets the index of the current step, i.e.
List<WelcomeStep>	getSteps()	Get all the steps (ordered).
List<Map<String,Object>>	getStepsAsMap()	Get all the steps (ordered) as maps.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractThreadSafeComponentExtensionPoint

addComponent, addExtension, contextualize, dispose, getExtension, getExtensionsIds, hasExtension, initialize, initializeExtensions, service

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ROLE

public static final String ROLE

Avalon Role

Constructor Details

WelcomeStepExtensionPoint

public WelcomeStepExtensionPoint()

Method Details

getSteps

public List<WelcomeStep> getSteps()

Get all the steps (ordered).

Returns:

The ordered list of the steps

getStepsAsMap

public List<Map<String,Object>> getStepsAsMap()

Get all the steps (ordered) as maps.

Returns:

The ordered list of the steps, as maps

getCurrentStep

public int getCurrentStep()

Gets the index of the current step, i.e. the first step which is not performed yet. If all steps are performed, return -1

Returns:

The index of the current step.