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

Interface WorkspaceModule

All Known Implementing Classes:

AbstractWorkspaceModule, CalendarWorkspaceModule, DocumentWorkspaceModule, EditionFOWorkspaceModule, MembersWorkspaceModule, TasksWorkspaceModule, ThreadWorkspaceModule

public interface WorkspaceModule

Manager for the Workspaces modules

Method Summary

Modifier and Type	Method	Description
void	activateModule(Project project)	Activate the module for the project, creating the module pages
void	deactivateModule(Project project)	Delete all data related to the module in the project, and the module pages
Set<String>	getAllowedEventTypes()	Get the set of allowed event type for the module
String	getId()	Get the module Id
String	getModuleName()	Get the module name
AmetysObjectIterable<Page>	getModulePages(Project project, String language)	Retrieves the pages of the module
ModifiableResourceCollection	getModuleRoot(Project project, boolean create)	Get the module root node for the given project
I18nizableText	getModuleTitle()	Get the module title
String	getModuleUrl(Project project, String language)	Get the URL of the first module's page
void	initializeSitemap(Sitemap sitemap)	Initialize the sitemap for the module

Method Detail

getId

String getId()

Get the module Id

Returns:

The module ID

getModuleTitle

I18nizableText getModuleTitle()

Get the module title

Returns:

The title

getModuleName

String getModuleName()

Get the module name

Returns:

the module name

activateModule

void activateModule(Project project)

Activate the module for the project, creating the module pages

Parameters:

project - The project

initializeSitemap

void initializeSitemap(Sitemap sitemap)

Initialize the sitemap for the module

Parameters:

sitemap - The sitemap

deactivateModule

void deactivateModule(Project project)

Delete all data related to the module in the project, and the module pages

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

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

getModulePages

AmetysObjectIterable<Page> getModulePages(Project project,
                                          String language)

Retrieves the pages of the module

Parameters:

project - The project

language - the sitemap language or null for all sitemap languages.

Returns:

the pages iterator

getModuleUrl

String getModuleUrl(Project project,
                    String language)

Get the URL of the first module's page

Parameters:

project - The project

language - the sitemap language. Cannot be null.

Returns:

the module url