org.osivia.services.calendar.portlet.service.generator

Interface ICalendarGenerator

All Known Implementing Classes:

CalendarGeneratorImpl, DailyCalendarGeneratorImpl, MonthlyCalendarGeneratorImpl, PlanningCalendarGeneratorImpl, WeeklyCalendarGeneratorImpl

public interface ICalendarGenerator

Calendar generator interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAYS_IN_WEEK Number of days in a week.

Method Summary

Modifier and Type	Method and Description
CalendarData	generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Generate calendar data.
EventsData	generateEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Generate events data.
PeriodTypes	getPeriodType() Get generator period type.
void	updateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData, Date selectedDate) Update calendar data.

Field Detail

DAYS_IN_WEEK

static final int DAYS_IN_WEEK

Number of days in a week.

See Also:

Constant Field Values

Method Detail

getPeriodType

PeriodTypes getPeriodType()
                   throws javax.portlet.PortletException

Get generator period type.

Returns:

period type

Throws:

javax.portlet.PortletException

generateCalendarData

CalendarData generateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                           throws javax.portlet.PortletException

Generate calendar data.

Parameters:

portalControllerContext - portal controller context

Returns:

calendar data

Throws:

javax.portlet.PortletException

updateCalendarData

void updateCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                        CalendarData calendarData,
                        Date selectedDate)
                 throws javax.portlet.PortletException

Update calendar data.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

selectedDate - selected date, may be null

Throws:

javax.portlet.PortletException

generateEventsData

EventsData generateEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                              CalendarData calendarData)
                       throws javax.portlet.PortletException

Generate events data.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

events data

Throws:

javax.portlet.PortletException