Class DocumentWorkspaceModule
java.lang.Object
org.ametys.runtime.plugin.component.AbstractLogEnabled
org.ametys.plugins.workspaces.AbstractWorkspaceModule
org.ametys.plugins.workspaces.documents.DocumentWorkspaceModule
- All Implemented Interfaces:
Comparable<WorkspaceModule>
,WorkspaceModule
,LogEnabled
,PluginAware
,Contextualizable
,Serviceable
Helper component for managing documents
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The id of document modulestatic final String
Workspaces documents node nameFields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule
_context, _currentUserProvider, _i18nUtils, _modulesEP, _observationManager, _pageDAO, _pluginName, _projectManager, _projectRightHelper, _resolver, _rightManager, _serviceEP, _skinsManager, _userHelper, _userManager
Fields inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule
ORDER_ALERTS, ORDER_CALENDAR, ORDER_DOCUMENTS, ORDER_MEMBERS, ORDER_NEWS, ORDER_TASKS, ORDER_THREADS, ORDER_WALLCONTENT, ORDER_WIKI
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
contextualize
(Context context) Get the set of allowed event type for the modulegetFolderUri
(Project project, String collectionId) Get the URI of a folder in project'sitegetId()
Get the module IdRetrieves the set of general rights used in the document module for the current userGet the module titleGet the module nameprotected String
Returns the module page's nameprotected I18nizableText
Returns the module page's title as i18ngetModuleRoot
(Project project, boolean create) Get the module root node for the given projectGet the module titleint
getOrder()
Get the module orderprotected void
initializeModulePage
(ModifiablePage documentPage) Initialize the module pageMethods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule
_createModulePage, _deleteEvents, _deletePages, _getAmetysObject, _getDefaultXslt, _getModulePages, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, activateModule, deactivateModule, deleteData, getModulePageTemplate, getModuleUrl, initializeSitemap, service, setPluginInfo
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
Methods inherited from interface org.ametys.plugins.workspaces.project.modules.WorkspaceModule
compareTo
-
Field Details
-
DODUMENT_MODULE_ID
The id of document module -
WORKSPACES_DOCUMENTS_NODE_NAME
Workspaces documents node name- See Also:
-
-
Constructor Details
-
DocumentWorkspaceModule
public DocumentWorkspaceModule()
-
-
Method Details
-
contextualize
- Specified by:
contextualize
in interfaceContextualizable
- Overrides:
contextualize
in classAbstractWorkspaceModule
- Throws:
ContextException
-
getId
Description copied from interface:WorkspaceModule
Get the module Id- Returns:
- The module ID
-
getModuleName
Description copied from interface:WorkspaceModule
Get the module name- Returns:
- the module name
-
getOrder
Description copied from interface:WorkspaceModule
Get the module order- Returns:
- the priority in menus
-
getModulePageName
Description copied from class:AbstractWorkspaceModule
Returns the module page's name- Specified by:
getModulePageName
in classAbstractWorkspaceModule
- Returns:
- The module page's name
-
getModuleTitle
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModuleDescription
Description copied from interface:WorkspaceModule
Get the module title- Returns:
- The title
-
getModulePageTitle
Description copied from class:AbstractWorkspaceModule
Returns the module page's title as i18n- Specified by:
getModulePageTitle
in classAbstractWorkspaceModule
- Returns:
- The module page's title
-
initializeModulePage
Description copied from class:AbstractWorkspaceModule
Initialize the module page- Specified by:
initializeModulePage
in classAbstractWorkspaceModule
- Parameters:
documentPage
- The module page
-
getFolderUri
Get the URI of a folder in project'site- Parameters:
project
- The projectcollectionId
- The id of collection- Returns:
- The thread uri
-
getModuleBaseRights
Retrieves the set of general rights used in the document module for the current user- Returns:
- The map of right data. Keys are the rights id, and values indicates whether the current user has the right or not.
-
getModuleRoot
Description copied from interface:WorkspaceModule
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
-
getAllowedEventTypes
Description copied from interface:WorkspaceModule
Get the set of allowed event type for the module- Returns:
- The set of allowed event types
-