org.exoplatform.calendar.service
Interface DataStorage

All Known Implementing Classes:

JCRDataStorage

public interface DataStorage

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Jan 19, 2010

Field Summary

static String

USERS_PATH

Method Summary

void	addAttachment(javax.jcr.Node eventNode, Attachment attachment, boolean isNew) Add an attachment to event
void	addCalendarSetting(javax.jcr.Node calendarHome, CalendarSetting setting)
void	addEvent(CalendarEvent event) Add a event
void	addReminder(javax.jcr.Node eventNode, javax.jcr.Node reminderFolder, Reminder reminder) Add a reminder to event
void	autoRemoveShareCalendar(String groupId, String username)
void	autoShareCalendar(List<String> groupsOfUser, String reciever)
boolean	canEdit(javax.jcr.Node calNode, String username) Get the permission to edit of user on the calendar
Map<String,String>	checkFreeBusy(EventQuery eventQuery)
void	closeSessionProvider(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider) Safely closes JCR session provider.
void	confirmInvitation(String fromUserId, String toUserId, int calType, String calendarId, String eventId, int answer)
void	confirmInvitation(String fromUserId, String confirmingEmail, String confirmingUser, int calType, String calendarId, String eventId, int answer)
Calendar	createRemoteCalendar(RemoteCalendar remoteCalendar) Create a new eXo calendar with mixin type 'exo:remoteCalendar' to store data from remote calendar, this method also creates a 'Remote' category
org.exoplatform.services.jcr.ext.common.SessionProvider	createSessionProvider() Create a session provider for current context.
org.exoplatform.services.jcr.ext.common.SessionProvider	createSystemProvider()
org.exoplatform.services.jcr.ext.common.SessionProvider	createUserProvider()
int	generateCalDav(String username, LinkedHashMap<String,Calendar> calendars, RssData rssData, CalendarImportExport importExport)
int	generateCalDav(String username, List<String> calendarIds, RssData rssData, CalendarImportExport importExport)
int	generateRss(String username, LinkedHashMap<String,Calendar> calendars, RssData rssData, CalendarImportExport importExport)
int	generateRss(String username, List<String> calendarIds, RssData rssData, CalendarImportExport importExport)
Calendar	getCalendar(String[] defaultFilterCalendars, String username, javax.jcr.Node calNode, boolean isShowAll)
List<GroupCalendarData>	getCalendarCategories(String username, boolean isShowAll)
CalendarCategory	getCalendarCategory(javax.jcr.Node calCategoryNode) Get calendar category from a JCR node
CalendarCategory	getCalendarCategory(String username, String calendarCategoryId) Get a calendar category of a user
CalendarSetting	getCalendarSetting(String username) Get calendar settings of a user
List<CalendarCategory>	getCategories(String username) Get all calendar categories of a user
javax.jcr.Node	getDateFolder(javax.jcr.Node publicApp, Date date)
String	getEntryUrl(String portalName, String wsName, String username, String path, String baseUrl)
CalendarEvent	getEvent(javax.jcr.Node eventNode) Get a event from event node
CalendarEvent	getEvent(String username, String eventId) Get a user event
List<EventCategory>	getEventCategories(String username) Get all event categories of a user
EventCategory	getEventCategory(javax.jcr.Node eventCatNode) Get a event category from node
EventCategory	getEventCategory(String username, String eventCategoryName) Get event category from name
javax.jcr.Node	getEventFolder(Date fromDate)
List<CalendarEvent>	getEvents(String username, EventQuery eventQuery, String[] publicCalendarIds)
List<FeedData>	getFeeds(String username)
Calendar	getGroupCalendar(String calendarId) Get a group calendar
List<GroupCalendarData>	getGroupCalendars(String[] groupIds, boolean isShowAll, String username)
CalendarEvent	getGroupEvent(String eventId) Get a group event with given eventId
CalendarEvent	getGroupEvent(String calendarId, String eventId) Get a group event
List<CalendarEvent>	getGroupEventByCalendar(List<String> calendarIds) Get all group events from list of calendars
javax.jcr.Node	getNodeByPath(String nodePath, org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
javax.jcr.Node	getPublicCalendarHome() Get the home node of all public calendars under public Calendar storage
javax.jcr.Node	getPublicCalendarServiceHome() Get the public Calendar application storage
List<CalendarEvent>	getPublicEventByCategory(String username, String eventCategoryId) Get all user public events from a category
List<CalendarEvent>	getPublicEvents(EventQuery eventQuery) Get all public events from a event query
javax.jcr.Node	getPublicRoot()
javax.jcr.Node	getReminderFolder(Date fromDate)
Calendar	getRemoteCalendar(String username, String remoteUrl, String remoteType)
int	getRemoteCalendarCount(String username)
javax.jcr.Node	getRssHome(String username) Get the home node of user feeds in Calendar application
javax.jcr.Session	getSession(org.exoplatform.services.jcr.ext.common.SessionProvider sprovider)
javax.jcr.Node	getSharedCalendarHome() Get the shared Calendar application storage
GroupCalendarData	getSharedCalendars(String username, boolean isShowAll) Get all shared calendars of a user
List<CalendarEvent>	getSharedEventByCalendars(String username, List<String> calendarIds) Get all shared events from list of calendars
List<CalendarEvent>	getSharedEventByCategory(String username, String eventCategoryId) Get all user shared events from a category
List<CalendarEvent>	getSharedEvents(String username, EventQuery eventQuery) Get all shared events with a EventQuery
int	getTypeOfCalendar(String userName, String calendarId)
Calendar	getUserCalendar(String username, String calendarId) Get a calendar under user calendar data storage
javax.jcr.Node	getUserCalendarHome(String username) Get the home node of user calendars under user calendar data storage
List<Calendar>	getUserCalendars(String username, boolean isShowAll) Get all calendars of a user
List<Calendar>	getUserCalendarsByCategory(String username, String calendarCategoryId) Get all calendars of a user by category
javax.jcr.Node	getUserCalendarServiceHome(String username) Get the Calendar application user data storage root
CalendarEvent	getUserEvent(String username, String calendarId, String eventId) Get a user event from calendarId and eventId
List<CalendarEvent>	getUserEventByCalendar(String username, List<String> calendarIds) Get all user events from a calendar
List<CalendarEvent>	getUserEventByCategory(String username, String eventCategoryId) Get all user events from a category
List<CalendarEvent>	getUserEvents(String username, EventQuery eventQuery) Get all user event with a event query
boolean	isRemoteCalendar(String username, String calendarId) Check if a calendar is a remote calendar by checking mixin type of calendar node
void	moveEvent(String formCalendar, String toCalendar, String fromType, String toType, List<CalendarEvent> calEvents, String username) Move events between calendars
CalendarCategory	removeCalendarCategory(String username, String calendarCategoryId) Remove a calendar category
void	removeEventCategory(String username, String eventCategoryName) Remove a user event category
void	removeFeed(String username, String calendarId)
Calendar	removeGroupCalendar(String calendarId) Remove a group calendar
CalendarEvent	removePublicEvent(String calendarId, String eventId) Remove a public event
void	removeReminder(javax.jcr.Node eventNode) Remove reminder from event
void	removeSharedCalendar(String username, String calendarId) Remove a shared calendar
void	removeSharedEvent(String username, String calendarId, String eventId)
Calendar	removeUserCalendar(String username, String calendarId) Remove a user calendar
CalendarEvent	removeUserEvent(String username, String calendarId, String eventId) Remove a user event
void	saveCalendarCategory(String username, CalendarCategory calendarCategory, boolean isNew) Save calendar category
void	saveCalendarSetting(String username, CalendarSetting setting) Save calendar setting of a user to JCR
void	saveEvent(javax.jcr.Node calendarNode, CalendarEvent event, javax.jcr.Node reminderFolder, boolean isNew) Save a event
void	saveEventCategory(String username, EventCategory eventCategory, boolean isNew) Save a user event category to JCR
void	saveEventToSharedCalendar(String username, String calendarId, CalendarEvent event, boolean isNew) Save a event to a shared calendar
void	savePublicCalendar(Calendar calendar, boolean isNew, String username) Save a public calendar
void	savePublicEvent(String calendarId, CalendarEvent event, boolean isNew) Save a public event
void	saveSharedCalendar(String username, Calendar calendar) Save a shared calendar to JCR
void	saveUserCalendar(String username, Calendar calendar, boolean isNew) Save a user calendar
void	saveUserEvent(String username, String calendarId, CalendarEvent event, boolean isNew) Save a user event
EventPageList	searchEvent(String username, EventQuery eventQuery, String[] publicCalendarIds)
Map<Integer,String>	searchHightLightEvent(String username, EventQuery eventQuery, String[] publicCalendarIds)
void	setCalDavResourceEtag(String username, String calendarId, String eventId, String etag)
void	setCalDavResourceHref(String username, String calendarId, String eventId, String href)
void	setRemoteCalendarLastUpdated(String username, String calendarId, Calendar timeGMT)
void	setRemoteEvent(String username, String calendarId, String eventId, String href, String etag)
void	shareCalendar(String username, String calendarId, List<String> receiverUsers) Shared a calendar to list of users
void	storeXML(String feedXML, javax.jcr.Node rssHome, RssData rssData)
void	syncRemoveEvent(javax.jcr.Node eventFolder, String rootEventId)
void	updateCalDav(String username, String calendarId, CalendarImportExport imp)
void	updateCalDav(String username, String calendarId, CalendarImportExport imp, int number)
Calendar	updateRemoteCalendarInfo(RemoteCalendar remoteCalendar) Update information about remote calendar
void	updateRss(String username, String calendarId, CalendarImportExport imp)
void	updateRss(String username, String calendarId, CalendarImportExport imp, int number)

Field Detail

USERS_PATH

static final String USERS_PATH

Method Detail

getPublicCalendarServiceHome

javax.jcr.Node getPublicCalendarServiceHome()
                                            throws Exception

Get the public Calendar application storage

Returns:

the node that is on top of Calendar application public storage

Throws:

Exception

getSharedCalendarHome

javax.jcr.Node getSharedCalendarHome()
                                     throws Exception

Get the shared Calendar application storage

Returns:

the node that is on top of Calendar application shared storage

Throws:

Exception

getPublicRoot

javax.jcr.Node getPublicRoot()
                             throws Exception

Returns:

Throws:

Exception

getUserCalendarServiceHome

javax.jcr.Node getUserCalendarServiceHome(String username)
                                          throws Exception

Get the Calendar application user data storage root

Parameters:

username -

Returns:

Node object represents the node that is on top of user data storage

Throws:

Exception

getPublicCalendarHome

javax.jcr.Node getPublicCalendarHome()
                                     throws Exception

Get the home node of all public calendars under public Calendar storage

Returns:

Node object represents the home node of all public calendars

Throws:

Exception

getUserCalendarHome

javax.jcr.Node getUserCalendarHome(String username)
                                   throws Exception

Get the home node of user calendars under user calendar data storage

Parameters:

username -

Returns:

Node object represents home node of user calendars

Throws:

Exception

getRssHome

javax.jcr.Node getRssHome(String username)
                          throws Exception

Get the home node of user feeds in Calendar application

Parameters:

username -

Returns:

Node object represents the home node of user feeds

Throws:

Exception

getUserCalendar

Calendar getUserCalendar(String username,
                         String calendarId)
                         throws Exception

Get a calendar under user calendar data storage

Parameters:

username -

calendarId -

Returns:

the Calendar object represents user calendar

Throws:

Exception

getUserCalendars

List<Calendar> getUserCalendars(String username,
                                boolean isShowAll)
                                throws Exception

Get all calendars of a user

Parameters:

username -

isShowAll -

Returns:

the list of all calendars of user

Throws:

Exception

getUserCalendarsByCategory

List<Calendar> getUserCalendarsByCategory(String username,
                                          String calendarCategoryId)
                                          throws Exception

Get all calendars of a user by category

Parameters:

username -

calendarCategoryId -

Returns:

the list of all user calendars from specific category

Throws:

Exception

saveUserCalendar

void saveUserCalendar(String username,
                      Calendar calendar,
                      boolean isNew)
                      throws Exception

Save a user calendar

Parameters:

username -

calendar -

isNew -

Throws:

Exception

removeUserCalendar

Calendar removeUserCalendar(String username,
                            String calendarId)
                            throws Exception

Remove a user calendar

Parameters:

username -

calendarId -

Returns:

the Calendar which is removed

Throws:

Exception

getGroupCalendar

Calendar getGroupCalendar(String calendarId)
                          throws Exception

Get a group calendar

Parameters:

calendarId -

Returns:

the group calendar

Throws:

Exception

getGroupCalendars

List<GroupCalendarData> getGroupCalendars(String[] groupIds,
                                          boolean isShowAll,
                                          String username)
                                          throws Exception

Parameters:

groupIds -

isShowAll -

username -

Returns:

the list of GroupCalendarData objects

Throws:

Exception

savePublicCalendar

void savePublicCalendar(Calendar calendar,
                        boolean isNew,
                        String username)
                        throws Exception

Save a public calendar

Parameters:

calendar -

isNew -

username -

Throws:

Exception

removeGroupCalendar

Calendar removeGroupCalendar(String calendarId)
                             throws Exception

Remove a group calendar

Parameters:

calendarId -

Returns:

Throws:

Exception

getCalendar

Calendar getCalendar(String[] defaultFilterCalendars,
                     String username,
                     javax.jcr.Node calNode,
                     boolean isShowAll)
                     throws Exception

Parameters:

defaultFilterCalendars -

username -

calNode -

isShowAll -

Returns:

Calendar object

Throws:

Exception

getCalendarCategories

List<GroupCalendarData> getCalendarCategories(String username,
                                              boolean isShowAll)
                                              throws Exception

Parameters:

username -

isShowAll -

Returns:

Throws:

Exception

getCategories

List<CalendarCategory> getCategories(String username)
                                     throws Exception

Get all calendar categories of a user

Parameters:

username -

Returns:

the list of calendar categories of user

Throws:

Exception

getCalendarCategory

CalendarCategory getCalendarCategory(String username,
                                     String calendarCategoryId)
                                     throws Exception

Get a calendar category of a user

Parameters:

username -

calendarCategoryId -

Returns:

the CalendarCategory object

Throws:

Exception

saveCalendarCategory

void saveCalendarCategory(String username,
                          CalendarCategory calendarCategory,
                          boolean isNew)
                          throws Exception

Save calendar category

Parameters:

username -

calendarCategory -

isNew -

Throws:

Exception

removeCalendarCategory

CalendarCategory removeCalendarCategory(String username,
                                        String calendarCategoryId)
                                        throws Exception

Remove a calendar category

Parameters:

username -

calendarCategoryId -

Returns:

the CalendarCategory which is removed

Throws:

Exception

getCalendarCategory

CalendarCategory getCalendarCategory(javax.jcr.Node calCategoryNode)
                                     throws Exception

Get calendar category from a JCR node

Parameters:

calCategoryNode -

Returns:

the CalendarCategory object

Throws:

Exception

getEventCategories

List<EventCategory> getEventCategories(String username)
                                       throws Exception

Get all event categories of a user

Parameters:

username -

Returns:

the list of EventCategory objects

Throws:

Exception

saveEventCategory

void saveEventCategory(String username,
                       EventCategory eventCategory,
                       boolean isNew)
                       throws Exception

Save a user event category to JCR

Parameters:

username -

eventCategory -

isNew -

Throws:

Exception

removeEventCategory

void removeEventCategory(String username,
                         String eventCategoryName)
                         throws Exception

Remove a user event category

Parameters:

username -

eventCategoryName -

Throws:

Exception

getEventCategory

EventCategory getEventCategory(javax.jcr.Node eventCatNode)
                               throws Exception

Get a event category from node

Parameters:

eventCatNode -

Returns:

the EventCategory object

Throws:

Exception

getEventCategory

EventCategory getEventCategory(String username,
                               String eventCategoryName)
                               throws Exception

Get event category from name

Parameters:

username -

eventCategoryName -

Returns:

the EventCategory object

Throws:

Exception

getUserEvent

CalendarEvent getUserEvent(String username,
                           String calendarId,
                           String eventId)
                           throws Exception

Get a user event from calendarId and eventId

Parameters:

username -

calendarId -

eventId -

Returns:

the CalendarEvent

Throws:

Exception

getUserEventByCalendar

List<CalendarEvent> getUserEventByCalendar(String username,
                                           List<String> calendarIds)
                                           throws Exception

Get all user events from a calendar

Parameters:

username -

calendarIds -

Returns:

the list of CalendarEvent object

Throws:

Exception

getPublicEventByCategory

List<CalendarEvent> getPublicEventByCategory(String username,
                                             String eventCategoryId)
                                             throws Exception

Get all user public events from a category

Parameters:

username -

eventCategoryId -

Returns:

the list of CalendarEvent

Throws:

Exception

getSharedEventByCategory

List<CalendarEvent> getSharedEventByCategory(String username,
                                             String eventCategoryId)
                                             throws Exception

Get all user shared events from a category

Parameters:

username -

eventCategoryId -

Returns:

the list of CalendarEvent

Throws:

Exception

getUserEventByCategory

List<CalendarEvent> getUserEventByCategory(String username,
                                           String eventCategoryId)
                                           throws Exception

Get all user events from a category

Parameters:

username -

eventCategoryId -

Returns:

the list of CalendarEvent

Throws:

Exception

getEvent

CalendarEvent getEvent(String username,
                       String eventId)
                       throws Exception

Get a user event

Parameters:

username -

eventId -

Returns:

the CalendarEvent

Throws:

Exception

getUserEvents

List<CalendarEvent> getUserEvents(String username,
                                  EventQuery eventQuery)
                                  throws Exception

Get all user event with a event query

Parameters:

username -

eventQuery -

Returns:

the list of CalendarEvent

Throws:

Exception

saveUserEvent

void saveUserEvent(String username,
                   String calendarId,
                   CalendarEvent event,
                   boolean isNew)
                   throws Exception

Save a user event

Parameters:

username -

calendarId -

event -

isNew -

Throws:

Exception

removeUserEvent

CalendarEvent removeUserEvent(String username,
                              String calendarId,
                              String eventId)
                              throws Exception

Remove a user event

Parameters:

username -

calendarId -

eventId -

Returns:

the CalendarEvent which is removed

Throws:

Exception

removeReminder

void removeReminder(javax.jcr.Node eventNode)
                    throws Exception

Remove reminder from event

Parameters:

eventNode -

Throws:

Exception

getGroupEvent

CalendarEvent getGroupEvent(String eventId)
                            throws Exception

Get a group event with given eventId

Parameters:

eventId -

Returns:

CalendarEvent object, or null if event was not found

Throws:

Exception

getGroupEvent

CalendarEvent getGroupEvent(String calendarId,
                            String eventId)
                            throws Exception

Get a group event

Parameters:

calendarId -

eventId -

Returns:

the CalendarEvent

Throws:

Exception

getGroupEventByCalendar

List<CalendarEvent> getGroupEventByCalendar(List<String> calendarIds)
                                            throws Exception

Get all group events from list of calendars

Parameters:

calendarIds -

Returns:

the list of CalendarEvent objects

Throws:

Exception

getPublicEvents

List<CalendarEvent> getPublicEvents(EventQuery eventQuery)
                                    throws Exception

Get all public events from a event query

Parameters:

eventQuery -

Returns:

the list of CalendarEvent objects

Throws:

Exception

savePublicEvent

void savePublicEvent(String calendarId,
                     CalendarEvent event,
                     boolean isNew)
                     throws Exception

Save a public event

Parameters:

calendarId -

event -

isNew -

Throws:

Exception

removePublicEvent

CalendarEvent removePublicEvent(String calendarId,
                                String eventId)
                                throws Exception

Remove a public event

Parameters:

calendarId -

eventId -

Returns:

CalendarEvent object

Throws:

Exception

getEvent

CalendarEvent getEvent(javax.jcr.Node eventNode)
                       throws Exception

Get a event from event node

Parameters:

eventNode -

Returns:

the CalendarEvent object

Throws:

Exception

saveEvent

void saveEvent(javax.jcr.Node calendarNode,
               CalendarEvent event,
               javax.jcr.Node reminderFolder,
               boolean isNew)
               throws Exception

Save a event

Parameters:

calendarNode -

event -

reminderFolder -

isNew -

Throws:

Exception

addReminder

void addReminder(javax.jcr.Node eventNode,
                 javax.jcr.Node reminderFolder,
                 Reminder reminder)
                 throws Exception

Add a reminder to event

Parameters:

eventNode -

reminderFolder -

reminder -

Throws:

Exception

addEvent

void addEvent(CalendarEvent event)
              throws Exception

Add a event

Parameters:

event -

Throws:

Exception

syncRemoveEvent

void syncRemoveEvent(javax.jcr.Node eventFolder,
                     String rootEventId)
                     throws Exception

Parameters:

eventFolder -

rootEventId -

Throws:

Exception

getReminderFolder

javax.jcr.Node getReminderFolder(Date fromDate)
                                 throws Exception

Parameters:

fromDate -

Returns:

Throws:

Exception

getEventFolder

javax.jcr.Node getEventFolder(Date fromDate)
                              throws Exception

Parameters:

fromDate -

Returns:

Throws:

Exception

getDateFolder

javax.jcr.Node getDateFolder(javax.jcr.Node publicApp,
                             Date date)
                             throws Exception

Parameters:

publicApp -

date -

Returns:

Node object

Throws:

Exception

addAttachment

void addAttachment(javax.jcr.Node eventNode,
                   Attachment attachment,
                   boolean isNew)
                   throws Exception

Add an attachment to event

Parameters:

eventNode - the event node

attachment - the attachment to add

isNew - is it a new attachment?

Throws:

Exception

saveCalendarSetting

void saveCalendarSetting(String username,
                         CalendarSetting setting)
                         throws Exception

Save calendar setting of a user to JCR

Parameters:

username - the username

setting - the setting to save

Throws:

Exception

addCalendarSetting

void addCalendarSetting(javax.jcr.Node calendarHome,
                        CalendarSetting setting)
                        throws Exception

Parameters:

calendarHome -

setting -

Throws:

Exception

getCalendarSetting

CalendarSetting getCalendarSetting(String username)
                                   throws Exception

Get calendar settings of a user

Parameters:

username -

Returns:

the CalendarSetting objects

Throws:

Exception

storeXML

void storeXML(String feedXML,
              javax.jcr.Node rssHome,
              RssData rssData)
              throws Exception

Parameters:

feedXML -

rssHome -

rssData -

Throws:

Exception

generateCalDav

int generateCalDav(String username,
                   LinkedHashMap<String,Calendar> calendars,
                   RssData rssData,
                   CalendarImportExport importExport)
                   throws Exception

Parameters:

username -

calendars -

rssData -

importExport -

Returns:

Throws:

Exception

removeFeed

void removeFeed(String username,
                String calendarId)
                throws Exception

Parameters:

username -

calendarId -

Throws:

Exception

getFeeds

List<FeedData> getFeeds(String username)
                        throws Exception

Parameters:

username -

Returns:

Throws:

Exception

generateRss

int generateRss(String username,
                List<String> calendarIds,
                RssData rssData,
                CalendarImportExport importExport)
                throws Exception

Parameters:

username -

calendarIds -

rssData -

importExport -

Returns:

Throws:

Exception

generateRss

int generateRss(String username,
                LinkedHashMap<String,Calendar> calendars,
                RssData rssData,
                CalendarImportExport importExport)
                throws Exception

Parameters:

username -

calendars -

rssData -

importExport -

Returns:

Throws:

Exception

updateRss

void updateRss(String username,
               String calendarId,
               CalendarImportExport imp)
               throws Exception

Parameters:

username -

calendarId -

imp -

Throws:

Exception

updateRss

void updateRss(String username,
               String calendarId,
               CalendarImportExport imp,
               int number)
               throws Exception

Parameters:

username -

calendarId -

imp -

number -

Throws:

Exception

updateCalDav

void updateCalDav(String username,
                  String calendarId,
                  CalendarImportExport imp)
                  throws Exception

Parameters:

username -

calendarId -

imp -

Throws:

Exception

updateCalDav

void updateCalDav(String username,
                  String calendarId,
                  CalendarImportExport imp,
                  int number)
                  throws Exception

Parameters:

username -

calendarId -

imp -

number -

Throws:

Exception

generateCalDav

int generateCalDav(String username,
                   List<String> calendarIds,
                   RssData rssData,
                   CalendarImportExport importExport)
                   throws Exception

Parameters:

username -

calendarIds -

rssData -

importExport -

Returns:

Throws:

Exception

getEntryUrl

String getEntryUrl(String portalName,
                   String wsName,
                   String username,
                   String path,
                   String baseUrl)
                   throws Exception

Parameters:

portalName -

wsName -

username -

path -

baseUrl -

Returns:

Throws:

Exception

searchEvent

EventPageList searchEvent(String username,
                          EventQuery eventQuery,
                          String[] publicCalendarIds)
                          throws Exception

Parameters:

username -

eventQuery -

publicCalendarIds -

Returns:

Throws:

Exception

searchHightLightEvent

Map<Integer,String> searchHightLightEvent(String username,
                                          EventQuery eventQuery,
                                          String[] publicCalendarIds)
                                          throws Exception

Parameters:

username -

eventQuery -

publicCalendarIds -

Returns:

Throws:

Exception

shareCalendar

void shareCalendar(String username,
                   String calendarId,
                   List<String> receiverUsers)
                   throws Exception

Shared a calendar to list of users

Parameters:

username -

calendarId -

receiverUsers -

Throws:

Exception

getSharedCalendars

GroupCalendarData getSharedCalendars(String username,
                                     boolean isShowAll)
                                     throws Exception

Get all shared calendars of a user

Parameters:

username -

isShowAll -

Returns:

the GroupCalendarData object contains list of all shared calendars belong to user

Throws:

Exception

saveSharedCalendar

void saveSharedCalendar(String username,
                        Calendar calendar)
                        throws Exception

Save a shared calendar to JCR

Parameters:

username -

calendar -

Throws:

Exception

getSharedEvents

List<CalendarEvent> getSharedEvents(String username,
                                    EventQuery eventQuery)
                                    throws Exception

Get all shared events with a EventQuery

Parameters:

username -

eventQuery -

Returns:

the list of CalendarEvent objects

Throws:

Exception

getSharedEventByCalendars

List<CalendarEvent> getSharedEventByCalendars(String username,
                                              List<String> calendarIds)
                                              throws Exception

Get all shared events from list of calendars

Parameters:

username -

calendarIds -

Returns:

the list of CalendarEvent objects

Throws:

Exception

removeSharedCalendar

void removeSharedCalendar(String username,
                          String calendarId)
                          throws Exception

Remove a shared calendar

Parameters:

username - the username

calendarId - the calendar id

Throws:

Exception

saveEventToSharedCalendar

void saveEventToSharedCalendar(String username,
                               String calendarId,
                               CalendarEvent event,
                               boolean isNew)
                               throws Exception

Save a event to a shared calendar

Parameters:

username -

calendarId -

event -

isNew -

Throws:

Exception

canEdit

boolean canEdit(javax.jcr.Node calNode,
                String username)
                throws Exception

Get the permission to edit of user on the calendar

Parameters:

calNode -

username -

Returns:

Throws:

Exception

getEvents

List<CalendarEvent> getEvents(String username,
                              EventQuery eventQuery,
                              String[] publicCalendarIds)
                              throws Exception

Parameters:

username -

eventQuery -

publicCalendarIds -

Returns:

Throws:

Exception

checkFreeBusy

Map<String,String> checkFreeBusy(EventQuery eventQuery)
                                 throws Exception

Parameters:

eventQuery -

Returns:

Throws:

Exception

removeSharedEvent

void removeSharedEvent(String username,
                       String calendarId,
                       String eventId)
                       throws Exception

Parameters:

username -

calendarId -

eventId -

Throws:

Exception

moveEvent

void moveEvent(String formCalendar,
               String toCalendar,
               String fromType,
               String toType,
               List<CalendarEvent> calEvents,
               String username)
               throws Exception

Move events between calendars

Parameters:

formCalendar -

toCalendar -

fromType -

toType -

calEvents -

username -

Throws:

Exception

confirmInvitation

void confirmInvitation(String fromUserId,
                       String toUserId,
                       int calType,
                       String calendarId,
                       String eventId,
                       int answer)

Parameters:

fromUserId -

toUserId -

calType -

calendarId -

eventId -

answer -

confirmInvitation

void confirmInvitation(String fromUserId,
                       String confirmingEmail,
                       String confirmingUser,
                       int calType,
                       String calendarId,
                       String eventId,
                       int answer)
                       throws Exception

Parameters:

fromUserId -

confirmingEmail -

confirmingUser -

calType -

calendarId -

eventId -

answer -

Throws:

Exception

getTypeOfCalendar

int getTypeOfCalendar(String userName,
                      String calendarId)

Parameters:

userName -

calendarId -

Returns:

createSessionProvider

org.exoplatform.services.jcr.ext.common.SessionProvider createSessionProvider()

Create a session provider for current context. The method first try to get a normal session provider, then attempts to create a system provider if the first one was not available.

Returns:

a SessionProvider initialized by current SessionProviderService

See Also:

SessionProviderService#getSessionProvider(null)

createUserProvider

org.exoplatform.services.jcr.ext.common.SessionProvider createUserProvider()

createSystemProvider

org.exoplatform.services.jcr.ext.common.SessionProvider createSystemProvider()

closeSessionProvider

void closeSessionProvider(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)

Safely closes JCR session provider. Call this method in finally to clean any provider initialized by createSessionProvider()

Parameters:

sessionProvider - the sessionProvider to close

See Also:

SessionProvider.close();

getNodeByPath

javax.jcr.Node getNodeByPath(String nodePath,
                             org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider)
                             throws Exception

Throws:

Exception

getSession

javax.jcr.Session getSession(org.exoplatform.services.jcr.ext.common.SessionProvider sprovider)
                             throws Exception

Throws:

Exception

autoShareCalendar

void autoShareCalendar(List<String> groupsOfUser,
                       String reciever)
                       throws Exception

Throws:

Exception

autoRemoveShareCalendar

void autoRemoveShareCalendar(String groupId,
                             String username)
                             throws Exception

Throws:

Exception

isRemoteCalendar

boolean isRemoteCalendar(String username,
                         String calendarId)
                         throws Exception

Check if a calendar is a remote calendar by checking mixin type of calendar node

Parameters:

username - owner of this calendar

calendarId - id of this calendar

Returns:

true if calendar node has mixin type exo:remoteCalendar, false if otherwise

Throws:

Exception

updateRemoteCalendarInfo

Calendar updateRemoteCalendarInfo(RemoteCalendar remoteCalendar)
                                  throws Exception

Update information about remote calendar

Parameters:

remoteCalendar - object content all properties for remote calendar.

Returns:

Throws:

Exception

createRemoteCalendar

Calendar createRemoteCalendar(RemoteCalendar remoteCalendar)
                              throws Exception

Create a new eXo calendar with mixin type 'exo:remoteCalendar' to store data from remote calendar, this method also creates a 'Remote' category

Parameters:

remoteCalendar - object content all properties for remote calendar.

Returns:

Calendar object

Throws:

Exception

setRemoteEvent

void setRemoteEvent(String username,
                    String calendarId,
                    String eventId,
                    String href,
                    String etag)
                    throws Exception

Throws:

Exception

setRemoteCalendarLastUpdated

void setRemoteCalendarLastUpdated(String username,
                                  String calendarId,
                                  Calendar timeGMT)
                                  throws Exception

Parameters:

username -

calendarId -

timeGMT -

Throws:

Exception

getRemoteCalendar

Calendar getRemoteCalendar(String username,
                           String remoteUrl,
                           String remoteType)
                           throws Exception

Throws:

Exception

getRemoteCalendarCount

int getRemoteCalendarCount(String username)
                           throws Exception

Throws:

Exception

setCalDavResourceHref

void setCalDavResourceHref(String username,
                           String calendarId,
                           String eventId,
                           String href)
                           throws Exception

Throws:

Exception

setCalDavResourceEtag

void setCalDavResourceEtag(String username,
                           String calendarId,
                           String eventId,
                           String etag)
                           throws Exception

Throws:

Exception