org.osivia.services.calendar.view.portlet.repository

Interface CalendarViewRepository

All Superinterfaces:

CalendarRepository

All Known Implementing Classes:

CalendarViewRepositoryImpl

public interface CalendarViewRepository
extends CalendarRepository

Calendar repository interface.

Author:

Cédric Krommenhoek, Julien Barberet

See Also:

CalendarRepository

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_DAY_PROPERTY All day Nuxeo property.
static String	BCKG_COLOR Background color
static String	CMS_PATH_WINDOW_PROPERTY CMS path window property name.
static String	COLOR_SYNCHRONIZATION Default color of synchronized events
static String	COMPACT_VIEW_WINDOW_PROPERTY Compact view indicator window property name.
static String	CREATED_SOURCE Creation date source
static String	DEFAULT_VIEW_WINDOW_PROPERTY Default view window property name.
static String	DESCRIPTION_PROPERTY Description
static String	DISPLAYNAME_SYNCHRONIZATION Default color of synchronized events
static String	DOCUMENT_TYPE_AGENDA Calendar document type name.
static String	DOCUMENT_TYPE_EVENEMENT Calendar event document type name.
static String	END_DATE_PROPERTY End date Nuxeo property.
static String	ID_PARENT_SOURCE_PROPERTY Id parent source
static String	ID_SOURCE_PROPERTY Id event source
static String	INTEGRATION_WINDOW_PROPERTY Integration indicator window property name.
static String	LAST_MODIFIED_SOURCE Last modified date source
static String	LIST_SOURCE_SYNCHRO List of synchronization sources
static String	PRIMARY_CALENDAR_COLOR Color of the primary calendar
static String	READ_ONLY_WINDOW_PROPERTY Read only indicator window property name.
static String	SOURCEID_SYNCHRONIZATION Source ID
static String	START_DATE_PROPERTY Start date Nuxeo property.
static String	START_DATE_RECCURING_SOURCE Start date of the recurring source event
static String	TITLE_PROPERTY Title
static String	URL_SYNCHRONIZATION URL to synchronize agenda

Fields inherited from interface org.osivia.services.calendar.common.repository.CalendarRepository

CALENDAR_COLOR_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	definePortletUri(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Define portlet URI.
String	getCalendarPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get calendar path.
String	getColorIdAgenda(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Return the colorId of the agenda
CalendarOptions	getConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get calendar configuration.
Event	getEvent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String docid) Get calendar event
List<Event>	getEvents(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, Date startDate, Date endDate) Get calendar events.
List<CalendarSynchronizationSource>	getSynchronizationSources(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Return the list of the synchronization sources of the current agenda
String	getTitle(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get calendar title.
boolean	isEventEditable(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String docid) To know if the event is editable
void	remove(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarViewForm form) Remove document using document_id
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarViewForm form) Save.
void	saveConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, CalendarOptions configuration) Save calendar configuration.
void	synchronize(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, Map<EventKey,EventToSync> map) Synchronization of events

Methods inherited from interface org.osivia.services.calendar.common.repository.CalendarRepository

getCurrentDocument, getTitle, insertContentMenubarItems, isWorkspace

Field Detail

CMS_PATH_WINDOW_PROPERTY

static final String CMS_PATH_WINDOW_PROPERTY

CMS path window property name.

See Also:

Constant Field Values

DEFAULT_VIEW_WINDOW_PROPERTY

static final String DEFAULT_VIEW_WINDOW_PROPERTY

Default view window property name.

See Also:

Constant Field Values

COMPACT_VIEW_WINDOW_PROPERTY

static final String COMPACT_VIEW_WINDOW_PROPERTY

Compact view indicator window property name.

See Also:

Constant Field Values

READ_ONLY_WINDOW_PROPERTY

static final String READ_ONLY_WINDOW_PROPERTY

Read only indicator window property name.

See Also:

Constant Field Values

INTEGRATION_WINDOW_PROPERTY

static final String INTEGRATION_WINDOW_PROPERTY

Integration indicator window property name.

See Also:

Constant Field Values

DOCUMENT_TYPE_EVENEMENT

static final String DOCUMENT_TYPE_EVENEMENT

Calendar event document type name.

See Also:

Constant Field Values

START_DATE_PROPERTY

static final String START_DATE_PROPERTY

Start date Nuxeo property.

See Also:

Constant Field Values

END_DATE_PROPERTY

static final String END_DATE_PROPERTY

End date Nuxeo property.

See Also:

Constant Field Values

ALL_DAY_PROPERTY

static final String ALL_DAY_PROPERTY

All day Nuxeo property.

See Also:

Constant Field Values

BCKG_COLOR

static final String BCKG_COLOR

Background color

See Also:

Constant Field Values

TITLE_PROPERTY

static final String TITLE_PROPERTY

Title

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

Description

See Also:

Constant Field Values

ID_SOURCE_PROPERTY

static final String ID_SOURCE_PROPERTY

Id event source

See Also:

Constant Field Values

ID_PARENT_SOURCE_PROPERTY

static final String ID_PARENT_SOURCE_PROPERTY

Id parent source

See Also:

Constant Field Values

CREATED_SOURCE

static final String CREATED_SOURCE

Creation date source

See Also:

Constant Field Values

LAST_MODIFIED_SOURCE

static final String LAST_MODIFIED_SOURCE

Last modified date source

See Also:

Constant Field Values

START_DATE_RECCURING_SOURCE

static final String START_DATE_RECCURING_SOURCE

Start date of the recurring source event

See Also:

Constant Field Values

DOCUMENT_TYPE_AGENDA

static final String DOCUMENT_TYPE_AGENDA

Calendar document type name.

See Also:

Constant Field Values

URL_SYNCHRONIZATION

static final String URL_SYNCHRONIZATION

URL to synchronize agenda

See Also:

Constant Field Values

SOURCEID_SYNCHRONIZATION

static final String SOURCEID_SYNCHRONIZATION

Source ID

See Also:

Constant Field Values

COLOR_SYNCHRONIZATION

static final String COLOR_SYNCHRONIZATION

Default color of synchronized events

See Also:

Constant Field Values

DISPLAYNAME_SYNCHRONIZATION

static final String DISPLAYNAME_SYNCHRONIZATION

Default color of synchronized events

See Also:

Constant Field Values

LIST_SOURCE_SYNCHRO

static final String LIST_SOURCE_SYNCHRO

List of synchronization sources

See Also:

Constant Field Values

PRIMARY_CALENDAR_COLOR

static final String PRIMARY_CALENDAR_COLOR

Color of the primary calendar

See Also:

Constant Field Values

Method Detail

getConfiguration

CalendarOptions getConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                          throws javax.portlet.PortletException

Get calendar configuration.

Parameters:

portalControllerContext - portal controller context

Returns:

calendar configuration

Throws:

javax.portlet.PortletException

saveConfiguration

void saveConfiguration(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                       CalendarOptions configuration)
                throws javax.portlet.PortletException

Save calendar configuration.

Parameters:

portalControllerContext - portal controller context

configuration - calendar configuration

Throws:

javax.portlet.PortletException

getCalendarPath

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

Get calendar path.

Parameters:

portalControllerContext - portal controller context

Returns:

path

Throws:

javax.portlet.PortletException

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

getEvents

List<Event> getEvents(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      Date startDate,
                      Date endDate)
               throws javax.portlet.PortletException

Get calendar events.

Parameters:

portalControllerContext - portal controller context

startDate -

endDate -

Returns:

calendar events

Throws:

javax.portlet.PortletException

getEvent

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

Get calendar event

Parameters:

portalControllerContext -

docid -

Returns:

Throws:

javax.portlet.PortletException

save

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

Save.

Parameters:

portalControllerContext - portal controller context

form - form

Throws:

javax.portlet.PortletException

remove

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

Remove document using document_id

Parameters:

portalControllerContext - portal controller context

form - form

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

isEventEditable

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

To know if the event is editable

Parameters:

portalControllerContext -

docid -

Returns:

Throws:

javax.portlet.PortletException

synchronize

void synchronize(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                 Map<EventKey,EventToSync> map)
          throws javax.portlet.PortletException

Synchronization of events

Parameters:

portalControllerContext -

map - map of events

Throws:

javax.portlet.PortletException

getSynchronizationSources

List<CalendarSynchronizationSource> getSynchronizationSources(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                                       throws javax.portlet.PortletException

Return the list of the synchronization sources of the current agenda

Parameters:

portalControllerContext -

Returns:

list of URLs

Throws:

javax.portlet.PortletException

getColorIdAgenda

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

Return the colorId of the agenda

Parameters:

portalControllerContext -

Returns:

Throws:

javax.portlet.PortletException