org.ametys.web.administration.welcome

Interface WelcomeStep

All Known Implementing Classes:

AbstractWelcomeStep, CompleteConfigurationStep, CompleteSiteStep, SiteWithPopulationStep, SiteWithUserStep

public interface WelcomeStep

Interface for steps to be performed after a fresh installation of Ametys has been done.

Method Summary

Modifier and Type	Method and Description
String[]	getActions() Gets the JS actions to execute when clicking on '<a>' elements of description.
I18nizableText	getDescription() Gets the text describing how to perform the step.
String[]	getImages() Gets the paths of the images to insert in the '<img/>' elements of description.
Map<String,Set<String>>	getListenedTargetIds() Gets the JS target ids (as regular expressions) to listen for each message type for potential changes in the steps and thus refresh the admin welcome tool.
int	getOrder() Gets the order of the step.
I18nizableText	getTitle() Gets the title of the step.
boolean	isPerformed() Checks if the step is performed.
default Map<String,Object>	toMap() Gets the representation of the step as a map.

Method Detail

isPerformed

boolean isPerformed()

Checks if the step is performed.

Returns:

true if the step is performed

getTitle

I18nizableText getTitle()

Gets the title of the step.

Returns:

The title as HTML

getDescription

I18nizableText getDescription()

Gets the text describing how to perform the step.

Returns:

The description as HTML

getActions

String[] getActions()

Gets the JS actions to execute when clicking on '<a>' elements of description.

Returns:

The JS actions to execute when clicking on '<a>' elements of description

getImages

String[] getImages()

Gets the paths of the images to insert in the '<img/>' elements of description.

Returns:

The paths of the images to insert in the '<img/>' elements of description.

getListenedTargetIds

Map<String,Set<String>> getListenedTargetIds()

Gets the JS target ids (as regular expressions) to listen for each message type for potential changes in the steps and thus refresh the admin welcome tool. For example, {"modified": ["^site$"], "deleted": ["^site$", "^user$"]}

Returns:

A map { messageType : [targetIds]}

getOrder

int getOrder()

Gets the order of the step.

Returns:

The order of the step

toMap

default Map<String,Object> toMap()

Gets the representation of the step as a map.

Returns:

The step as a map