org.osivia.services.calendar.portlet.service

Interface ICalendarService

All Known Implementing Classes:

CalendarServiceImpl

public interface ICalendarService

Calendar service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERIOD_TYPE_PARAMETER Period type render parameter name.
static DateFormat	SELECTED_DATE_FORMAT Selected date format.
static String	SELECTED_DATE_PARAMETER Selected date render parameter name.

Method Summary

Modifier and Type	Method and Description
void	definePortletUri(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Define portlet URI.
CalendarData	getCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String periodTypeName) Get calendar data.
EventsData	getEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Get events data.
String	getTitle(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get calendar title.
String	getViewPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Get view path.
boolean	isCompact(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Check if current calendar is compact.
String	selectNextPeriod(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Select next period.
String	selectPreviousPeriod(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Select previous period.

Field Detail

SELECTED_DATE_FORMAT

static final DateFormat SELECTED_DATE_FORMAT

Selected date format.

PERIOD_TYPE_PARAMETER

static final String PERIOD_TYPE_PARAMETER

Period type render parameter name.

See Also:

Constant Field Values

SELECTED_DATE_PARAMETER

static final String SELECTED_DATE_PARAMETER

Selected date render parameter name.

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
         throws javax.portlet.PortletException

Get calendar title.

Parameters:

portalControllerContext - portal controller context

Returns:

title

Throws:

javax.portlet.PortletException

getCalendarData

CalendarData getCalendarData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                             String periodTypeName)
                      throws javax.portlet.PortletException

Get calendar data.

Parameters:

portalControllerContext - portal controller context

periodTypeName - period type name, may be null

Returns:

calendar data

Throws:

javax.portlet.PortletException

isCompact

boolean isCompact(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
           throws javax.portlet.PortletException

Check if current calendar is compact.

Parameters:

portalControllerContext - portal controller context

Returns:

true if compact

Throws:

javax.portlet.PortletException

getEventsData

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

Get events data.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

calendar events

Throws:

javax.portlet.PortletException

getViewPath

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

Get view path.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

view path

Throws:

javax.portlet.PortletException

selectPreviousPeriod

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

Select previous period.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

selected date

Throws:

javax.portlet.PortletException

selectNextPeriod

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

Select next period.

Parameters:

portalControllerContext - portal controller context

calendarData - calendar data

Returns:

selected date

Throws:

javax.portlet.PortletException

definePortletUri

void definePortletUri(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
               throws javax.portlet.PortletException

Define portlet URI.

Parameters:

portalControllerContext - portal controller context

Throws:

javax.portlet.PortletException