Interface WorkspaceModule
- All Superinterfaces:
Comparable<WorkspaceModule>
- All Known Implementing Classes:
AbstractWorkspaceModule
,AlertWorkspaceModule
,CalendarWorkspaceModule
,DocumentWorkspaceModule
,EditionFOWorkspaceModule
,MembersWorkspaceModule
,NewsWorkspaceModule
,TasksWorkspaceModule
,ThreadWorkspaceModule
,WallContentModule
Manager for the Workspaces modules
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of modulestatic final int
Order of module -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateModule
(Project project) Activate the module for the project, creating the module pagesdefault int
compareTo
(WorkspaceModule that) void
deactivateModule
(Project project) Deactivate a modulevoid
deleteData
(Project project) Delete a module and all related data (pages, events, resources, ...)Get the set of allowed event type for the modulegetId()
Get the module IdGet the module titleGet the module namegetModuleRoot
(Project project, boolean create) Get the module root node for the given projectGet the module titlegetModuleUrl
(Project project) Get the URL of the first module's pageint
getOrder()
Get the module ordervoid
initializeSitemap
(Project project, Sitemap sitemap) Initialize the sitemap for the module
-
Field Details
-
ORDER_WALLCONTENT
Order of module- See Also:
-
ORDER_NEWS
Order of module- See Also:
-
ORDER_ALERTS
Order of module- See Also:
-
ORDER_MEMBERS
Order of module- See Also:
-
ORDER_DOCUMENTS
Order of module- See Also:
-
ORDER_THREADS
Order of module- See Also:
-
ORDER_CALENDAR
Order of module- See Also:
-
ORDER_TASKS
Order of module- See Also:
-
ORDER_WIKI
Order of module- See Also:
-
-
Method Details
-
getId
Get the module Id- Returns:
- The module ID
-
getModuleTitle
Get the module title- Returns:
- The title
-
getModuleDescription
Get the module title- Returns:
- The title
-
getModuleName
Get the module name- Returns:
- the module name
-
getOrder
int getOrder()Get the module order- Returns:
- the priority in menus
-
activateModule
Activate the module for the project, creating the module pages- Parameters:
project
- The project
-
initializeSitemap
Initialize the sitemap for the module- Parameters:
project
- The project of the modulesitemap
- The sitemap
-
deactivateModule
Deactivate a module- Parameters:
project
- The project
-
deleteData
Delete a module and all related data (pages, events, resources, ...)- Parameters:
project
- The project
-
getAllowedEventTypes
Get the set of allowed event type for the module- Returns:
- The set of allowed event types
-
getModuleRoot
Get the module root node for the given project- Parameters:
project
- The project containing the modulecreate
- 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
Get the URL of the first module's page- Parameters:
project
- The project- Returns:
- the module url
-
compareTo
- Specified by:
compareTo
in interfaceComparable<WorkspaceModule>
-