Package org.ametys.plugins.workspaces.calendars

Class CalendarWorkspaceModule

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceModule

org.ametys.plugins.workspaces.calendars.CalendarWorkspaceModule

All Implemented Interfaces:

WorkspaceModule, LogEnabled, PluginAware, Contextualizable, Serviceable

public class CalendarWorkspaceModule
extends AbstractWorkspaceModule

Helper component for managing calendars

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	CalendarWorkspaceModule.StartDateComparator	Compares events on their starting date

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__CALENDAR_CACHE_REQUEST_ATTR
private static String	__CALENDAR_MODULE_TAG	Tag on the main page holding the calendar module
private static String	__MODULE_TITLE_KEY	Module i18n title key
private static String	__WORKSPACES_CALENDARS_NODE_NAME	Workspaces calendars node name
private WorkspaceCalendarDAO	_calendarDAO
static String	CALENDAR_MODULE_ID	The id of calendar module

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

_context, _currentUserProvider, _i18nUtils, _observationManager, _pageDAO, _pluginName, _projectManager, _projectRightHelper, _resolver, _rightManager, _serviceEP, _skinsManager, _userHelper, _userManager

Constructor Summary

Constructors

Constructor	Description
CalendarWorkspaceModule()

Method Summary

Modifier and Type	Method	Description
protected void	_addAdditionalEventData(CalendarEvent event, Map<String,Object> eventData)	Add additional information on project and parent calendar
private boolean	_filterEvent(List<String> calendarIds, CalendarEvent event)	Determine whether the given event has to be kept or not depending on the given calendars
private boolean	_hasAccess(Calendar calendar)
Map<String,Object>	addCalendar(String inputName, String description, String templateDesc, String color, String visibility, String workflowName, Boolean renameIfExists)	Add a calendar
boolean	canView(Calendar calendar)	Indicates if the current user can view the calendar
boolean	canView(CalendarEvent event)	Indicates if the current user can view the event
Set<String>	getAllowedEventTypes()	Get the set of allowed event type for the module
AmetysObjectIterable<Calendar>	getCalendars(Project project)	Get the calendars of a project
List<Map<String,Object>>	getCalendarsData()	Get the data of every available calendar of the application
Map<String,Object>	getCalendarServiceRights(List<String> calendarIds)	Get the rights of the current user for the calendar service
String	getEventUri(Project project, String calendarId, String eventId, String language)	Get the URI of a thread in project'site
String	getId()	Get the module Id
Map<String,Object>	getModuleBaseRights()	Retrieves the set of general rights used in the calendar module for the current user
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
protected String	getModuleTagName()	Returns the tag of apply to module page
I18nizableText	getModuleTitle()	Get the module title
List<Map<String,Object>>	getUpcomingEvents(int months, int maxResults, List<String> calendarIds, List<String> tagIds)	Get the upcoming events of the calendars on which the user has a right
List<Map<String,Object>>	getUpcomingEvents(String months, String maxResults, List<String> calendarIds, List<String> tagIds)	Get the upcoming events of the calendars on which the user has a right
protected void	initializeModulePage(ModifiablePage calendarPage)	Initialize the module page
void	service(ServiceManager manager)

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

_createModulePage, _deletePages, _getAmetysObject, _getDefaultXslt, _internalActivateModule, _internalDeactivateModule, activateModule, contextualize, deactivateModule, getModulePages, getModulePageTemplate, getModuleUrl, 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

Field Detail

CALENDAR_MODULE_ID

public static final String CALENDAR_MODULE_ID

The id of calendar module

__CALENDAR_MODULE_TAG

private static final String __CALENDAR_MODULE_TAG

Tag on the main page holding the calendar module

See Also:

Constant Field Values

__WORKSPACES_CALENDARS_NODE_NAME

private static final String __WORKSPACES_CALENDARS_NODE_NAME

Workspaces calendars node name

See Also:

Constant Field Values

__CALENDAR_CACHE_REQUEST_ATTR

private static final String __CALENDAR_CACHE_REQUEST_ATTR

__MODULE_TITLE_KEY

private static final String __MODULE_TITLE_KEY

Module i18n title key

See Also:

Constant Field Values

_calendarDAO

private WorkspaceCalendarDAO _calendarDAO

Constructor Detail

CalendarWorkspaceModule

public CalendarWorkspaceModule()

Method Detail

service

public void service(ServiceManager manager)
             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

getModuleTitle

public I18nizableText getModuleTitle()

Description copied from interface: WorkspaceModule

Get the module title

Returns:

The title

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

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

getModuleTagName

protected String getModuleTagName()

Description copied from class: AbstractWorkspaceModule

Returns the tag of apply to module page

Specified by:

getModuleTagName in class AbstractWorkspaceModule

Returns:

The tag for module page

initializeModulePage

protected void initializeModulePage(ModifiablePage calendarPage)

Description copied from class: AbstractWorkspaceModule

Initialize the module page

Specified by:

initializeModulePage in class AbstractWorkspaceModule

Parameters:

calendarPage - The module page

getCalendars

public AmetysObjectIterable<Calendar> getCalendars(Project project)

Get the calendars of a project

Parameters:

project - The project

Returns:

The list of calendar

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

getModuleBaseRights

public Map<String,Object> getModuleBaseRights()

Retrieves the set of general rights used in the calendar 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.

getCalendarServiceRights

public Map<String,Object> getCalendarServiceRights(List<String> calendarIds)

Get the rights of the current user for the calendar service

Parameters:

calendarIds - The list of calendars

Returns:

The rights

getEventUri

public String getEventUri(Project project,
                          String calendarId,
                          String eventId,
                          String language)

Get the URI of a thread in project'site

Parameters:

project - The project

calendarId - The id of calendar

eventId - The id of event

language - The sitemap language

Returns:

The thread uri

addCalendar

public Map<String,Object> addCalendar(String inputName,
                                            String description,
                                            String templateDesc,
                                            String color,
                                            String visibility,
                                            String workflowName,
                                            Boolean renameIfExists)
                                     throws IllegalAccessException

Add a calendar

Parameters:

inputName - The desired name for the calendar

description - The calendar description

templateDesc - The calendar template description

color - The calendar color

visibility - The calendar visibility

workflowName - The calendar workflow name

renameIfExists - True to rename if existing

Returns:

The result map with id, parentId and name keys

Throws:

IllegalAccessException - If the user has no sufficient rights

_addAdditionalEventData

protected void _addAdditionalEventData(CalendarEvent event,
                                       Map<String,Object> eventData)

Add additional information on project and parent calendar

Parameters:

event - The event

eventData - The event data to complete

getUpcomingEvents

public List<Map<String,Object>> getUpcomingEvents(String months,
                                                        String maxResults,
                                                        List<String> calendarIds,
                                                        List<String> tagIds)

Get the upcoming events of the calendars on which the user has a right

Parameters:

months - the amount of months from today in which look for upcoming events

maxResults - the maximum results to display

calendarIds - the ids of the calendars to gather events from, null for all calendars

tagIds - the ids of the valid tags for the events, null for any tag

Returns:

the upcoming events

getUpcomingEvents

public List<Map<String,Object>> getUpcomingEvents(int months,
                                                        int maxResults,
                                                        List<String> calendarIds,
                                                        List<String> tagIds)

Get the upcoming events of the calendars on which the user has a right

Parameters:

months - the amount of months from today in which look for upcoming events

maxResults - the maximum results to display

calendarIds - the ids of the calendars to gather events from, null for all calendars

tagIds - the ids of the valid tags for the events, null for any tag

Returns:

the upcoming events

_filterEvent

private boolean _filterEvent(List<String> calendarIds,
                             CalendarEvent event)

Determine whether the given event has to be kept or not depending on the given calendars

Parameters:

calendarIds - the ids of the calendars

event - the event

Returns:

true if the event can be kept, false otherwise

_hasAccess

private boolean _hasAccess(Calendar calendar)

getCalendarsData

public List<Map<String,Object>> getCalendarsData()

Get the data of every available calendar of the application

Returns:

the list of calendar data

canView

public boolean canView(Calendar calendar)

Indicates if the current user can view the calendar

Parameters:

calendar - The calendar to test

Returns:

true if the calendar can be viewed

canView

public boolean canView(CalendarEvent event)

Indicates if the current user can view the event

Parameters:

event - The event to test

Returns:

true if the event can be viewed

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