org.osivia.services.calendar.view.portlet.service

Interface CalendarViewService

All Superinterfaces:

CalendarService

All Known Implementing Classes:

CalendarViewServiceImpl

public interface CalendarViewService
extends CalendarService

Calendar service interface.

Author:

Cédric Krommenhoek, Julien Barberet

See Also:

CalendarService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATE_PARAMETER Date render parameter name.
static String	DOCUMENT_TYPE_PROPERTY Document type window property.
static String	MODE_PROPERTY Calendar edition mode identifier window property.
static String	PERIOD_TYPE_PARAMETER Period type render parameter name.
static SimpleDateFormat	SELECTED_DATE_FORMAT Selected date format.

Fields inherited from interface org.osivia.services.calendar.common.service.CalendarService

CREATION_PROPERTY

Method Summary

Modifier and Type	Method and Description
EventToSync	buildEvent(net.fortuna.ical4j.model.component.VEvent vevent, String idAgenda, net.fortuna.ical4j.model.TimeZone timeZoneAllEvent) Build event
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.
String	getColorIdAgenda(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Return the id of the color of the agenda
Event	getEvent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String docid) Get docid
EventsData	getEventsData(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Get events data.
String	getIntegrationUrl(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get integration URL.
Map<String,CalendarColor>	getSourcesColor(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Return the map of the different color (primary color of the calendar and color of each synchrnonization sources)
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.
void	integrate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, OutputStream outputStream, String format) Integrate calendar.
boolean	isCalendarReadOnly(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Check if calendar is read only.
boolean	isCompact(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Check if current calendar is compact.
boolean	isEventEditable(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String docid) Return true if event is editable
net.sf.json.JSONArray	loadEventsArray(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarData calendarData) Load events array
void	remove(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarViewForm form) Remove event
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarViewForm form) Save event
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.
void	synchronize(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Synchronization of events

Methods inherited from interface org.osivia.services.calendar.common.service.CalendarService

getCalendarColor, getEditionOptions, getOptions

Field Detail

DOCUMENT_TYPE_PROPERTY

static final String DOCUMENT_TYPE_PROPERTY

Document type window property.

See Also:

Constant Field Values

MODE_PROPERTY

static final String MODE_PROPERTY

Calendar edition mode identifier window property.

See Also:

Constant Field Values

SELECTED_DATE_FORMAT

static final SimpleDateFormat 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

DATE_PARAMETER

static final String DATE_PARAMETER

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

getEvent

Event getEvent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
               String docid)
        throws javax.portlet.PortletException

Get docid

Parameters:

portalControllerContext -

docid -

Returns:

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

save

void save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
          CalendarViewForm form)
   throws javax.portlet.PortletException

Save event

Parameters:

portalControllerContext -

form -

Throws:

javax.portlet.PortletException

remove

void remove(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
            CalendarViewForm form)
     throws javax.portlet.PortletException

Remove event

Parameters:

portalControllerContext -

form -

options -

Throws:

javax.portlet.PortletException

isEventEditable

boolean isEventEditable(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                        String docid)
                 throws javax.portlet.PortletException

Return true if event is editable

Parameters:

portalControllerContext -

docid -

Returns:

Throws:

javax.portlet.PortletException

synchronize

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

Synchronization of events

Parameters:

portalControllerContext -

Throws:

javax.portlet.PortletException

getSourcesColor

Map<String,CalendarColor> getSourcesColor(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                   throws javax.portlet.PortletException

Return the map of the different color (primary color of the calendar and color of each synchrnonization sources)

Parameters:

portalControllerContext -

Returns:

Throws:

javax.portlet.PortletException

getColorIdAgenda

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

Return the id of the color of the agenda

Parameters:

portalControllerContext -

Returns:

Throws:

javax.portlet.PortletException

isCalendarReadOnly

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

Check if calendar is read only.

Parameters:

portalControllerContext - portal controller context

Returns:

true if calendar is read only

Throws:

javax.portlet.PortletException

loadEventsArray

net.sf.json.JSONArray loadEventsArray(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                      CalendarData calendarData)
                               throws javax.portlet.PortletException

Load events array

Parameters:

portalControllerContext -

calendarData -

Returns:

Throws:

javax.portlet.PortletException

buildEvent

EventToSync buildEvent(net.fortuna.ical4j.model.component.VEvent vevent,
                       String idAgenda,
                       net.fortuna.ical4j.model.TimeZone timeZoneAllEvent)
                throws javax.portlet.PortletException

Build event

Parameters:

vevent -

idAgenda -

timeZoneAllEvent -

Returns:

Throws:

javax.portlet.PortletException

integrate

void integrate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
               OutputStream outputStream,
               String format)
        throws javax.portlet.PortletException,
               IOException

Integrate calendar.

Parameters:

portalControllerContext - portal controller context

outputStream - output steam

format - calendar integration format

Throws:

javax.portlet.PortletException

IOException

getIntegrationUrl

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

Get integration URL.

Parameters:

portalControllerContext - portal controller context

Returns:

URL

Throws:

javax.portlet.PortletException