Package org.ametys.plugins.workspaces.documents

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

public class DocumentWorkspaceModule
extends AbstractWorkspaceModule

Helper component for managing documents

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOCUMENT_MODULE_ID	The id of document module
static final String	WORKSPACES_DOCUMENTS_NODE_NAME	Workspaces documents node name

Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule

__SIZE_ERROR, __SIZE_INACTIVE, _activityStream, _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

GROUP_HEADER_ACTIVATED_ID, GROUP_HEADER_ELEMENTS_ID, GROUP_HEADER_LAST_ACTIVITY_ID, GROUP_HEADER_SIZE_ID, ORDER_ABOUT, ORDER_ALERTS, ORDER_CALENDAR, ORDER_DOCUMENTS, ORDER_MEMBERS, ORDER_MINISITE, ORDER_NEWS, ORDER_TASKS, ORDER_THREADS, ORDER_WALLCONTENT

Constructor Summary

Constructors

Constructor	Description
DocumentWorkspaceModule()

Method Summary

Modifier and Type	Method	Description
List<StatisticColumn>	_getInternalStatisticModel()	Get the headers of statistics
Map<String,Object>	_getInternalStatistics(Project project, boolean isActive)	Get the internal statistics of the module
protected long	_getModuleSize(Project project)	Get the size of module in bytes
protected boolean	_showModuleSize()	Check if module size should be shown or not
void	contextualize(Context context)
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	getFolderUri(Project project, String collectionId)	Get the URI of a folder in project'site
String	getId()	Get the module Id
Map<String,Object>	getModuleBaseRights()	Retrieves the set of general rights used in the document module for the current user
I18nizableText	getModuleDescription()	Get the module title
String	getModuleName()	Get the module name
protected String	getModulePageName()	Returns the module page's name
protected I18nizableText	getModulePageTitle()	Returns the module page's title as i18n
ModifiableResourceCollection	getModuleRoot(Project project, boolean create)	Get the module root node for the given project
I18nizableText	getModuleTitle()	Get the module title
int	getOrder()	Get the module order
protected void	initializeModulePage(ModifiablePage documentPage)	Initialize the module page

Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceModule

_createModulePage, _deleteActivities, _deletePages, _getAmetysObject, _getDefaultXslt, _getModuleLastActivity, _getModulePages, _internalActivateModule, _internalDeactivateModule, _internalDeleteData, _setPagesVisibility, _showActivatedStatus, _showLastActivity, activateModule, deactivateModule, deleteData, getModulePageTemplate, getModuleSizeKey, getModuleUrl, getStatisticModel, getStatistics, 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, isUnactivatedByDefault

Field Details

DOCUMENT_MODULE_ID

public static final String DOCUMENT_MODULE_ID

The id of document module

WORKSPACES_DOCUMENTS_NODE_NAME

public static final String WORKSPACES_DOCUMENTS_NODE_NAME

Workspaces documents node name

See Also:

• Constant Field Values

Constructor Details

DocumentWorkspaceModule

public DocumentWorkspaceModule()

Method Details

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Overrides:

contextualize in class AbstractWorkspaceModule

Throws:

ContextException

getId

public String getId()

Description copied from interface: WorkspaceModule

Get the module Id

Returns:

The module ID

getModuleName

public String getModuleName()

Description copied from interface: WorkspaceModule

Get the module name

Returns:

the module name

getOrder

public int getOrder()

Description copied from interface: WorkspaceModule

Get the module order

Returns:

the priority in menus

getModulePageName

protected String getModulePageName()

Description copied from class: AbstractWorkspaceModule

Returns the module page's name

Specified by:

getModulePageName in class AbstractWorkspaceModule

Returns:

The module page's name

getModuleTitle

public I18nizableText getModuleTitle()

Description copied from interface: WorkspaceModule

Get the module title

Returns:

The title

getModuleDescription

public I18nizableText getModuleDescription()

Description copied from interface: WorkspaceModule

Get the module title

Returns:

The title

getModulePageTitle

protected I18nizableText getModulePageTitle()

Description copied from class: AbstractWorkspaceModule

Returns the module page's title as i18n

Specified by:

getModulePageTitle in class AbstractWorkspaceModule

Returns:

The module page's title

initializeModulePage

protected void initializeModulePage(ModifiablePage documentPage)

Description copied from class: AbstractWorkspaceModule

Initialize the module page

Specified by:

initializeModulePage in class AbstractWorkspaceModule

Parameters:

documentPage - The module page

getFolderUri

public String getFolderUri(Project project,
 String collectionId)

Get the URI of a folder in project'site

Parameters:

project - The project

collectionId - The id of collection

Returns:

The thread uri

getModuleBaseRights

public Map<String,Object> 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

public ModifiableResourceCollection getModuleRoot(Project project,
 boolean create)

Description copied from interface: WorkspaceModule

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

getAllowedEventTypes

public Set<String> getAllowedEventTypes()

Description copied from interface: WorkspaceModule

Get the set of allowed event type for the module

Returns:

The set of allowed event types

_getInternalStatistics

public Map<String,Object> _getInternalStatistics(Project project,
 boolean isActive)

Description copied from class: AbstractWorkspaceModule

Get the internal statistics of the module

Overrides:

_getInternalStatistics in class AbstractWorkspaceModule

Parameters:

project - The project

isActive - true if module is active

Returns:

a map of internal statistics

_getInternalStatisticModel

public List<StatisticColumn> _getInternalStatisticModel()

Description copied from class: AbstractWorkspaceModule

Get the headers of statistics

Overrides:

_getInternalStatisticModel in class AbstractWorkspaceModule

Returns:

a list of statistics headers

_getModuleSize

protected long _getModuleSize(Project project)

Description copied from class: AbstractWorkspaceModule

Get the size of module in bytes

Overrides:

_getModuleSize in class AbstractWorkspaceModule

Parameters:

project - The project

Returns:

the size of module in bytes

_showModuleSize

protected boolean _showModuleSize()

Description copied from class: AbstractWorkspaceModule

Check if module size should be shown or not

Overrides:

_showModuleSize in class AbstractWorkspaceModule

Returns:

true if module size should be shown

getAllEventTypes

public Set<String> getAllEventTypes()

Description copied from interface: WorkspaceModule

Get the set of all event type for the module

Specified by:

getAllEventTypes in interface WorkspaceModule

Overrides:

getAllEventTypes in class AbstractWorkspaceModule

Returns:

The set of all event types