Package org.ametys.plugins.workspaces.tasks

Class TasksWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

org.ametys.plugins.workspaces.tasks.TasksWorkspaceModule

All Implemented Interfaces:

Comparable<WorkspaceModule>, WorkspaceModule, LogEnabled, PluginAware, Contextualizable, Serviceable

public class TasksWorkspaceModule
extends AbstractWorkspaceModule

Tasks manager for workspaces

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TASK_MODULE_ID	The id of task module

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
TasksWorkspaceModule()

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
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
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
DefaultTraversableAmetysObject	getTasksListsRoot(Project project, boolean create)	Get the root for tasks lists
Map<String,Object>	getTasksModuleRights()	Retrieves the rights for the current user in the project
DefaultTraversableAmetysObject	getTasksRoot(Project project, boolean create)	Get the root for tasks
Map<String,Object>	getTasksServiceRights(List<String> projectNames)	Retrieves the rights for the current user in the projects list
String	getTaskUri(Project project, String taskId)	Get the URI of a task in project'site
protected void	initializeModulePage(ModifiablePage taskPage)	Initialize the module page
void	service(ServiceManager serviceManager)

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

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

TASK_MODULE_ID

public static final String TASK_MODULE_ID

The id of task module

Constructor Details

TasksWorkspaceModule

public TasksWorkspaceModule()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceModule

Throws:

ServiceException

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 taskPage)

Description copied from class: AbstractWorkspaceModule

Initialize the module page

Specified by:

initializeModulePage in class AbstractWorkspaceModule

Parameters:

taskPage - The module page

getTasksModuleRights

public Map<String,Object> getTasksModuleRights()

Retrieves the rights for the current user in the project

Returns:

The project

getTasksServiceRights

public Map<String,Object> getTasksServiceRights(List<String> projectNames)

Retrieves the rights for the current user in the projects list

Parameters:

projectNames - The name of projects to checks rights from

Returns:

The rights data

getTaskUri

public String getTaskUri(Project project,
 String taskId)

Get the URI of a task in project'site

Parameters:

project - The project

taskId - The id of the task

Returns:

The thread uri

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

getTasksRoot

public DefaultTraversableAmetysObject getTasksRoot(Project project,
 boolean create)

Get the root for tasks

Parameters:

project - The project

create - true to create root if not exists

Returns:

The root for tasks

getTasksListsRoot

public DefaultTraversableAmetysObject getTasksListsRoot(Project project,
 boolean create)

Get the root for tasks lists

Parameters:

project - The project

create - true to create root if not exists

Returns:

The root for tasks lists

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

_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

_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

_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