Package org.ametys.plugins.workspaces.project.modules

Interface WorkspaceModule

All Superinterfaces:

Comparable<WorkspaceModule>

All Known Implementing Classes:

AboutWorkspaceModule, AbstractWorkspaceModule, AlertWorkspaceModule, CalendarWorkspaceModule, DocumentWorkspaceModule, ForumWorkspaceModule, MembersWorkspaceModule, MiniSiteWorkspaceModule, NewsWorkspaceModule, TasksWorkspaceModule, WallContentModule

public interface WorkspaceModule
extends Comparable<WorkspaceModule>

Manager for the Workspaces modules

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GROUP_HEADER_ACTIVATED_ID	Header id for activated group header
static final String	GROUP_HEADER_ELEMENTS_ID	Header id for elements group header
static final String	GROUP_HEADER_LAST_ACTIVITY_ID	Header id for last activity group header
static final String	GROUP_HEADER_SIZE_ID	Header id for size group header
static final int	ORDER_ABOUT	Order of module
static final int	ORDER_ALERTS	Order of module
static final int	ORDER_CALENDAR	Order of module
static final int	ORDER_DOCUMENTS	Order of module
static final int	ORDER_FORUMS	Order of module
static final int	ORDER_MEMBERS	Order of module
static final int	ORDER_MINISITE	Order of module
static final int	ORDER_NEWS	Order of module
static final int	ORDER_TASKS	Order of module
static final int	ORDER_WALLCONTENT	Order of module

Method Summary

Modifier and Type	Method	Description
void	activateModule(Project project, Map<String,Object> additionalValues)	Activate the module for the project, creating the module pages
default int	compareTo(WorkspaceModule that)
void	deactivateModule(Project project)	Deactivate a module
void	deleteData(Project project)	Delete a module and all related data (pages, events, resources, ...)
Set<String>	getAllEventTypes()	Get the set of all event type for the module
Set<String>	getAllowedEventTypes()	Get the set of allowed event type for the module
String	getId()	Get the module Id
I18nizableText	getModuleDescription()	Get the module title
String	getModuleName()	Get the module name
ModifiableResourceCollection	getModuleRoot(Project project, boolean create)	Get the module root node for the given project
String	getModuleSizeKey()	Returns the key to get module size in statistics
I18nizableText	getModuleTitle()	Get the module title
String	getModuleUrl(Project project)	Get the URL of the first module's page
int	getOrder()	Get the module order
List<StatisticColumn>	getStatisticModel()	Get the headers of statistics
Map<String,Object>	getStatistics(Project project)	Get the statistics of the module
void	initializeSitemap(Project project, Sitemap sitemap)	Initialize the sitemap for the module
default boolean	isUnactivatedByDefault()	Determines if the module is unactivated by default

Field Details

ORDER_WALLCONTENT

static final int ORDER_WALLCONTENT

Order of module

See Also:

• Constant Field Values

ORDER_NEWS

static final int ORDER_NEWS

Order of module

See Also:

• Constant Field Values

ORDER_ALERTS

static final int ORDER_ALERTS

Order of module

See Also:

• Constant Field Values

ORDER_MEMBERS

static final int ORDER_MEMBERS

Order of module

See Also:

• Constant Field Values

ORDER_DOCUMENTS

static final int ORDER_DOCUMENTS

Order of module

See Also:

• Constant Field Values

ORDER_FORUMS

static final int ORDER_FORUMS

Order of module

See Also:

• Constant Field Values

ORDER_CALENDAR

static final int ORDER_CALENDAR

Order of module

See Also:

• Constant Field Values

ORDER_TASKS

static final int ORDER_TASKS

Order of module

See Also:

• Constant Field Values

ORDER_MINISITE

static final int ORDER_MINISITE

Order of module

See Also:

• Constant Field Values

ORDER_ABOUT

static final int ORDER_ABOUT

Order of module

See Also:

• Constant Field Values

GROUP_HEADER_ELEMENTS_ID

static final String GROUP_HEADER_ELEMENTS_ID

Header id for elements group header

See Also:

• Constant Field Values

GROUP_HEADER_SIZE_ID

static final String GROUP_HEADER_SIZE_ID

Header id for size group header

See Also:

• Constant Field Values

GROUP_HEADER_ACTIVATED_ID

static final String GROUP_HEADER_ACTIVATED_ID

Header id for activated group header

See Also:

• Constant Field Values

GROUP_HEADER_LAST_ACTIVITY_ID

static final String GROUP_HEADER_LAST_ACTIVITY_ID

Header id for last activity group header

See Also:

• Constant Field Values

Method Details

getId

String getId()

Get the module Id

Returns:

The module ID

getModuleTitle

I18nizableText getModuleTitle()

Get the module title

Returns:

The title

getModuleDescription

I18nizableText getModuleDescription()

Get the module title

Returns:

The title

getModuleName

String getModuleName()

Get the module name

Returns:

the module name

getOrder

int getOrder()

Get the module order

Returns:

the priority in menus

activateModule

void activateModule(Project project,
 Map<String,Object> additionalValues)

Activate the module for the project, creating the module pages

Parameters:

project - The project

additionalValues - A list of optional additional values. Accepted values are : description, mailingList, inscriptionStatus, defaultProfile, tags, categoryTags, keywords and language

initializeSitemap

void initializeSitemap(Project project,
 Sitemap sitemap)

Initialize the sitemap for the module

Parameters:

project - The project of the module

sitemap - The sitemap

deactivateModule

void deactivateModule(Project project)

Deactivate a module

Parameters:

project - The project

deleteData

void deleteData(Project project)

Delete a module and all related data (pages, events, resources, ...)

Parameters:

project - The project

getAllowedEventTypes

Set<String> getAllowedEventTypes()

Get the set of allowed event type for the module

Returns:

The set of allowed event types

getAllEventTypes

Set<String> getAllEventTypes()

Get the set of all event type for the module

Returns:

The set of all event types

getModuleRoot

ModifiableResourceCollection getModuleRoot(Project project,
 boolean create)

Get the module root node for the given project

Parameters:

project - The project containing the module

create - True to create the node if it does not exists

Returns:

The root node, or null if it does not exists and was not created

getModuleUrl

String getModuleUrl(Project project)

Get the URL of the first module's page

Parameters:

project - The project

Returns:

the module url

isUnactivatedByDefault

default boolean isUnactivatedByDefault()

Determines if the module is unactivated by default

Returns:

true if the module is not proposed by default

compareTo

default int compareTo(WorkspaceModule that)

Specified by:

compareTo in interface Comparable<WorkspaceModule>

getStatistics

Map<String,Object> getStatistics(Project project)

Get the statistics of the module

Parameters:

project - The project

Returns:

a map of statistics

getStatisticModel

List<StatisticColumn> getStatisticModel()

Get the headers of statistics

Returns:

a list of statistics headers

getModuleSizeKey

String getModuleSizeKey()

Returns the key to get module size in statistics

Returns:

The key to get module size in statistics