org.osivia.services.calendar.view.portlet.controller

Class ViewCalendarController

java.lang.Object

org.osivia.services.calendar.view.portlet.controller.ViewCalendarController

@Controller
@RequestMapping(value="VIEW")
public class ViewCalendarController
extends Object

View calendar controller.

Author:

Cédric Krommenhoek, Julien Barberet

Field Summary

Fields

Modifier and Type	Field and Description
protected org.osivia.portal.api.internationalization.IBundleFactory	bundleFactory Bundle factory.
protected static String	CALENDAR_DATA_ATTRIBUTE Calendar data request attribute.
protected CalendarViewService	calendarService Calendar service.
protected org.osivia.portal.api.notifications.INotificationsService	notificationsService Notifications service.
protected javax.portlet.PortletContext	portletContext Portlet context.

Constructor Summary

Constructors

Constructor and Description
ViewCalendarController() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	dataLoading(javax.portlet.ResourceResponse response, org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Event's loading from calendarData's start date and end date
void	dragndrop(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletSession session, String startDate, String endDate, String docid, String title, String scrollViewDayWeek, String scrollViewMonth, String period, String date) Event'save after drag and drop
CalendarData	getCalendarData(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, String periodTypeName) Get calendar data.
String	handleException(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, Exception exception) Exception handler.
void	initSchedulerData(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, CalendarData calendarData, String periodTypeName, Date selectedDate) Ajax call to load scheduler events
void	integration(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, String format) Calendar integration resource mapping.
void	isEventEditable(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, String id)
void	loadData(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, String start, String end, CalendarData calendarData) Events loading between start date and end date parameters
void	remove(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletSession session, String docid, String scrollViewDayWeek, String scrollViewMonth, String period, String date) Event's removal
protected void	setResponseParameter(javax.portlet.ActionResponse response, String date, String period, String scrollViewDayWeek, String scrollViewMonth)
void	synchronize(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletSession session) Synchronization
String	view(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, String startDate, String periodType, String scrollViewDayWeek, String scrollViewMonth, CalendarData calendarData) View calendar render mapping
void	viewEvent(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, javax.portlet.PortletSession session, String docid, String scrollViewDayWeek, String scrollViewMonth) Action called to view event's details

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CALENDAR_DATA_ATTRIBUTE

protected static final String CALENDAR_DATA_ATTRIBUTE

Calendar data request attribute.

See Also:

Constant Field Values

portletContext

@Autowired
protected javax.portlet.PortletContext portletContext

Portlet context.

calendarService

@Autowired
protected CalendarViewService calendarService

Calendar service.

bundleFactory

@Autowired
protected org.osivia.portal.api.internationalization.IBundleFactory bundleFactory

Bundle factory.

notificationsService

@Autowired
protected org.osivia.portal.api.notifications.INotificationsService notificationsService

Notifications service.

Constructor Detail

ViewCalendarController

public ViewCalendarController()

Constructor.

Method Detail

view

@RenderMapping
public String view(javax.portlet.RenderRequest request,
                        javax.portlet.RenderResponse response,
                        @RequestParam(value="date",required=false)
                        String startDate,
                        @RequestParam(value="period",required=false)
                        String periodType,
                        @RequestParam(value="scrollViewDayWeek",required=false)
                        String scrollViewDayWeek,
                        @RequestParam(value="scrollViewMonth",required=false)
                        String scrollViewMonth,
                        @ModelAttribute
                        CalendarData calendarData)
            throws javax.portlet.PortletException

View calendar render mapping

Parameters:

request - render request

response - render response

selectedDate - request parameter, may be null

Returns:

view path

Throws:

javax.portlet.PortletException

initSchedulerData

@ResourceMapping(value="initSchedulerData")
public void initSchedulerData(javax.portlet.ResourceRequest request,
                                     javax.portlet.ResourceResponse response,
                                     @ModelAttribute(value="calendarData")
                                     CalendarData calendarData,
                                     @RequestParam(value="period",required=false)
                                     String periodTypeName,
                                     @RequestParam(value="date",required=false)
                                     Date selectedDate)
                       throws javax.portlet.PortletException,
                              IOException

Ajax call to load scheduler events

Parameters:

request - resource request

response - resource response

path - parent path, may be null for root node

Throws:

javax.portlet.PortletException

IOException

loadData

@ResourceMapping(value="loadData")
public void loadData(javax.portlet.ResourceRequest request,
                            javax.portlet.ResourceResponse response,
                            @RequestParam(name="start",required=false)
                            String start,
                            @RequestParam(name="end",required=false)
                            String end,
                            @ModelAttribute(value="calendarData")
                            CalendarData calendarData)
              throws javax.portlet.PortletException,
                     IOException

Events loading between start date and end date parameters

Parameters:

request - resource request

response - resource response

start - start date request parameter

end - end date request parameter

calendarData - calendar data model attribute

Throws:

javax.portlet.PortletException

IOException

isEventEditable

@ResourceMapping(value="isEventEditable")
public void isEventEditable(javax.portlet.ResourceRequest request,
                                   javax.portlet.ResourceResponse response,
                                   @RequestParam(value="id",required=true)
                                   String id)
                     throws javax.portlet.PortletException,
                            IOException

Throws:

javax.portlet.PortletException

IOException

viewEvent

@ActionMapping(value="viewEvent")
public void viewEvent(javax.portlet.ActionRequest request,
                           javax.portlet.ActionResponse response,
                           javax.portlet.PortletSession session,
                           @RequestParam(value="doc_id")
                           String docid,
                           @RequestParam(value="scrollViewDayWeek",required=false)
                           String scrollViewDayWeek,
                           @RequestParam(value="scrollViewMonth",required=false)
                           String scrollViewMonth)
               throws javax.portlet.PortletException,
                      IOException

Action called to view event's details

Parameters:

request - resource request

response - resource response

path - parent path, may be null for root node

Throws:

javax.portlet.PortletException

IOException

dragndrop

@ActionMapping(value="dragndrop")
public void dragndrop(javax.portlet.ActionRequest request,
                           javax.portlet.ActionResponse response,
                           javax.portlet.PortletSession session,
                           @RequestParam(value="start")
                           String startDate,
                           @RequestParam(value="end")
                           String endDate,
                           @RequestParam(value="doc_id")
                           String docid,
                           @RequestParam(value="title")
                           String title,
                           @RequestParam(value="scrollViewDayWeek",required=false)
                           String scrollViewDayWeek,
                           @RequestParam(value="scrollViewMonth",required=false)
                           String scrollViewMonth,
                           @RequestParam(value="period")
                           String period,
                           @RequestParam(value="date")
                           String date)
               throws javax.portlet.PortletException,
                      IOException

Event'save after drag and drop

Parameters:

request -

response -

session -

startDate -

endDate -

docid -

title -

scrollViewDayWeek -

scrollViewMonth -

period -

date -

Throws:

javax.portlet.PortletException

IOException

remove

@ActionMapping(value="remove")
public void remove(javax.portlet.ActionRequest request,
                        javax.portlet.ActionResponse response,
                        javax.portlet.PortletSession session,
                        @RequestParam(value="doc_id")
                        String docid,
                        @RequestParam(value="scrollViewDayWeek",required=false)
                        String scrollViewDayWeek,
                        @RequestParam(value="scrollViewMonth",required=false)
                        String scrollViewMonth,
                        @RequestParam(value="period")
                        String period,
                        @RequestParam(value="date")
                        String date)
            throws javax.portlet.PortletException,
                   IOException

Event's removal

Parameters:

request -

response -

session -

docid -

scrollViewDayWeek -

scrollViewMonth -

period -

date -

Throws:

javax.portlet.PortletException

IOException

synchronize

@ActionMapping(value="synchronize")
public void synchronize(javax.portlet.ActionRequest request,
                             javax.portlet.ActionResponse response,
                             javax.portlet.PortletSession session)
                 throws javax.portlet.PortletException,
                        IOException

Synchronization

Parameters:

request -

response -

session -

scrollViewDayWeek -

scrollViewMonth -

period -

date -

Throws:

javax.portlet.PortletException

IOException

integration

@ResourceMapping(value="integration")
public void integration(javax.portlet.ResourceRequest request,
                               javax.portlet.ResourceResponse response,
                               @RequestParam(name="format",required=false)
                               String format)
                 throws javax.portlet.PortletException,
                        IOException

Calendar integration resource mapping.

Parameters:

request - resource request

response - resource response

format - calendar integration format request parameter

Throws:

javax.portlet.PortletException

IOException

getCalendarData

@ModelAttribute(value="calendarData")
public CalendarData getCalendarData(javax.portlet.PortletRequest request,
                                          javax.portlet.PortletResponse response,
                                          @RequestParam(value="period",required=false)
                                          String periodTypeName)
                             throws javax.portlet.PortletException

Get calendar data.

Parameters:

request - portlet request

response - portlet response

periodTypeName - period type name request parameter, may be null

Returns:

calendar data

Throws:

javax.portlet.PortletException

handleException

@ExceptionHandler(value=java.lang.Exception.class)
public String handleException(javax.portlet.PortletRequest request,
                                                               javax.portlet.PortletResponse response,
                                                               Exception exception)

Exception handler.

Parameters:

request - portlet request

response - portlet response

exception - current exception

Returns:

error path

dataLoading

protected void dataLoading(javax.portlet.ResourceResponse response,
               org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
               CalendarData calendarData)
                    throws javax.portlet.PortletException,
                           IOException

Event's loading from calendarData's start date and end date

Parameters:

response -

portalControllerContext -

calendarData -

Throws:

javax.portlet.PortletException

IOException

setResponseParameter

protected void setResponseParameter(javax.portlet.ActionResponse response,
                        String date,
                        String period,
                        String scrollViewDayWeek,
                        String scrollViewMonth)