org.exoplatform.calendar.service
Interface CalendarService

All Superinterfaces:

CalendarServiceLegacy

All Known Implementing Classes:

CalendarServiceImpl

public interface CalendarService
extends CalendarServiceLegacy

Created by The eXo Platform SARL Author : Hung Nguyen Quang hung.nguyen@exoplatform.com Jul 11, 2007

Method Summary

void	addListenerPlugin(CalendarUpdateEventListener listener)
java.util.Map<java.lang.String,java.lang.String>	checkFreeBusy(EventQuery eventQuery) The method will check the time free or busy of the user, it depends on events and tasks of this user now it only check on one day and if the events and tasks marked with busy, out side status will be checked
void	confirmInvitation(java.lang.String fromUserId, java.lang.String toUserId, int calType, java.lang.String calendarId, java.lang.String eventId, int answer) The method calls when the user use exo mail product only, when user receives an invitation (in the same data system), the user will confirm that do they want to take part in or not
void	confirmInvitation(java.lang.String fromUserId, java.lang.String confirmingEmail, java.lang.String confirmingUser, int calType, java.lang.String calendarId, java.lang.String eventId, int answer)
int	generateCalDav(java.lang.String username, java.util.LinkedHashMap<java.lang.String,Calendar> calendars, RssData rssData) The method generate links to access calendar throw WEBDAV, it will require user name and password when access
int	generateCalDav(java.lang.String username, java.util.List<java.lang.String> calendarIds, RssData rssData) The method generate links to access calendar throw WEBDAV, it will require user name and password when access
int	generateRss(java.lang.String username, java.util.LinkedHashMap<java.lang.String,Calendar> calendars, RssData rssData) The method uses to make URL to contains links to subscriber calendar follows RSS stand
int	generateRss(java.lang.String username, java.util.List<java.lang.String> calendarIds, RssData rssData) The method uses to make URL to contains links to subscribe calendar follows RSS stand
java.util.List<GroupCalendarData>	getCalendarCategories(java.lang.String username, boolean isShowAll) The method gets all groups of private calendar, and each GroupCalendar contains List of Calendar object
CalendarCategory	getCalendarCategory(java.lang.String username, java.lang.String calendarCategoryId) The method gets the calendar category by given id
CalendarImportExport	getCalendarImportExports(java.lang.String type) The method gets Import/Export implement class to import or export ICS,CSV
CalendarSetting	getCalendarSetting(java.lang.String username) This method gets informations of current user's setting
java.util.List<CalendarCategory>	getCategories(java.lang.String username) The method gets all calendar category of current user from data base
CalendarEvent	getEvent(java.lang.String username, java.lang.String eventId) Get a personal event for a given owner
java.util.List<EventCategory>	getEventCategories(java.lang.String username) The method gets all categories of event
EventCategory	getEventCategory(java.lang.String username, java.lang.String eventCategoryId) The method gets category of event by given id
java.util.List<CalendarEvent>	getEvents(java.lang.String username, EventQuery eventQuery, java.lang.String[] publicCalendarIds) The method selects all the events and tasks by given conditions, it includes events of private, public and share calendars
java.lang.String[]	getExportImportType() The method gets types of data will be imported and exported
java.util.List<FeedData>	getFeeds(java.lang.String username) It gets data form server and show the URL to view contents of RSS
Calendar	getGroupCalendar(java.lang.String calendarId) The method gets all calendar of a group user, we called it is group calendar it means the calendar for group of users and depend on the permission the user will have right to view or edit that calendar
java.util.List<GroupCalendarData>	getGroupCalendars(java.lang.String[] groupIds, boolean isShowAll, java.lang.String username) The method gets all the group calendar data of current user and list of calendars belong to that group with group calendar data it will classify calendar to each group
CalendarEvent	getGroupEvent(java.lang.String calendarId, java.lang.String eventId) The method gets event or task form group calendar by given calendar id
java.util.List<CalendarEvent>	getGroupEventByCalendar(java.util.List<java.lang.String> calendarIds) The method gets events and tasks by given public calendar IDs
java.util.List<CalendarEvent>	getPublicEvents(EventQuery eventQuery) The method gets events and tasks by given event query
javax.jcr.Node	getRssHome(java.lang.String username) The method return root of RSS data store area
GroupCalendarData	getSharedCalendars(java.lang.String username, boolean isShowAll) The method gets all shared calendars of the current user
int	getTypeOfCalendar(java.lang.String userName, java.lang.String calendarId)
Calendar	getUserCalendar(java.lang.String username, java.lang.String calendarId) The method get private calendar by given calendarId, and all calendar related to this category will be removed
java.util.List<Calendar>	getUserCalendars(java.lang.String username, boolean isShowAll) The method queries all private calendars of current user
java.util.List<Calendar>	getUserCalendarsByCategory(java.lang.String username, java.lang.String calendarCategoryId) The method look up all private calendars by given category id
java.util.List<CalendarEvent>	getUserEventByCalendar(java.lang.String username, java.util.List<java.lang.String> calendarIds) The method gets list events and tasks of given private calendar IDs
java.util.List<CalendarEvent>	getUserEvents(java.lang.String username, EventQuery eventQuery) The method gets all events and tasks by given conditions in event query
void	moveEvent(java.lang.String formCalendar, java.lang.String toCalendar, java.lang.String formType, java.lang.String toType, java.util.List<CalendarEvent> calEvents, java.lang.String username) The method move and save events form private calendars share calendars public calendars each other
CalendarCategory	removeCalendarCategory(java.lang.String username, java.lang.String calendarCategoryId) The method used for removing one category by id
void	removeEventCategory(java.lang.String username, java.lang.String eventCategoryName) Remove event category, all events and tasks belong to this category will be destroyed
Calendar	removePublicCalendar(java.lang.String calendarId) Remove the group calendar form data base, every events, tasks inside this calendar will be removed too
CalendarEvent	removePublicEvent(java.lang.String calendarId, java.lang.String eventId) Remove event or task, all attachments and reminders item will be removed
void	removeSharedCalendar(java.lang.String username, java.lang.String calendarId) Removed shared calendar, but not the original calendar
void	removeSharedEvent(java.lang.String username, java.lang.String calendarId, java.lang.String eventId) The method removes the events or tasks form shared calendar, original item will be removed
Calendar	removeUserCalendar(java.lang.String username, java.lang.String calendarId) Remove private calendar by given id, all events and tasks belong to this calendar will be removed
CalendarEvent	removeUserEvent(java.lang.String username, java.lang.String calendarId, java.lang.String eventId) Remove given event or task in private calendar with calendar id, all attachments and reminders will be removed
void	saveCalendarCategory(java.lang.String username, CalendarCategory calendarCategory, boolean isNew) Save details of category for a user
void	saveCalendarSetting(java.lang.String username, CalendarSetting setting) This method stores individual setting of each user, with setting you can configuration many things like Default view date, time formating, time interval
void	saveEventCategory(java.lang.String username, EventCategory eventCategory, java.lang.String[] values, boolean isNew) Save event category to data base, every user will have their own category to classify events, and it will use unique name in data base
void	saveEventToSharedCalendar(java.lang.String username, java.lang.String calendarId, CalendarEvent event, boolean isNew) Add event to shared calendar, mean add event to original calendar too
void	savePublicCalendar(Calendar calendar, boolean isNew, java.lang.String username) The method save calendar to public area (group calendar)
void	savePublicEvent(java.lang.String calendarId, CalendarEvent event, boolean isNew) Save event or task by given group calendar id
void	saveSharedCalendar(java.lang.String username, Calendar calendar) The method save all informations about shared calendar, it will be updated original calendar
void	saveUserCalendar(java.lang.String username, Calendar calendar, boolean isNew) The method saves private calendar informations in to data base
void	saveUserEvent(java.lang.String username, java.lang.String calendarId, CalendarEvent event, boolean isNew) The method save information to an event or a task by given private calendar id to data
EventPageList	searchEvent(java.lang.String username, EventQuery eventQuery, java.lang.String[] publicCalendarIds) The method query events and tasks form given conditions, the conditions know by set value for eventquery
java.util.Map<java.lang.Integer,java.lang.String>	searchHightLightEvent(java.lang.String username, EventQuery eventQuery, java.lang.String[] publicCalendarIds) The method query all events, tasks and mark to highlight the date have events or tasks
void	shareCalendar(java.lang.String username, java.lang.String calendarId, java.util.List<java.lang.String> receiverUsers) The method share the private calendar to other user, it can share for one or many users
void	updateCalDav(java.lang.String usename, java.lang.String calendarId, CalendarImportExport imp) The method update exited RSS data when calendar has been changed
void	updateCalDav(java.lang.String usename, java.lang.String calendarId, CalendarImportExport imp, int number)
void	updateRss(java.lang.String usename, java.lang.String calendarId, CalendarImportExport imp) The method update exited RSS data when calendar has been changed
void	updateRss(java.lang.String usename, java.lang.String calendarId, CalendarImportExport imp, int number)

Methods inherited from interface org.exoplatform.calendar.service.CalendarServiceLegacy

checkFreeBusy, generateRss, getCalendarCategories, getCalendarCategory, getCalendarSetting, getCategories, getEventCategories, getEventCategory, getEvents, getFeeds, getGroupCalendar, getGroupCalendars, getGroupEvent, getGroupEventByCalendar, getPublicEvents, getRssHome, getSharedCalendars, getUserCalendar, getUserCalendars, getUserCalendarsByCategory, getUserEventByCalendar, getUserEvents, moveEvent, removeCalendarCategory, removeEventCategory, removePublicCalendar, removePublicEvent, removeSharedCalendar, removeSharedEvent, removeUserCalendar, removeUserEvent, saveCalendarCategory, saveCalendarSetting, saveEventCategory, saveEventToSharedCalendar, savePublicCalendar, savePublicEvent, saveSharedCalendar, saveUserCalendar, saveUserEvent, searchEvent, searchHightLightEvent, shareCalendar

Method Detail

getCategories

java.util.List<CalendarCategory> getCategories(java.lang.String username)
                                               throws java.lang.Exception

The method gets all calendar category of current user from data base

Parameters:

username - current user name

Returns:

List of CalendarCategory object

Throws:

java.lang.Exception

See Also:

CalendarCategory

getCalendarCategories

java.util.List<GroupCalendarData> getCalendarCategories(java.lang.String username,
                                                        boolean isShowAll)
                                                        throws java.lang.Exception

The method gets all groups of private calendar, and each GroupCalendar contains List of Calendar object

Parameters:

username - current user name

isShowAll - The parameter to make sure that the user want to show all calendar or not, if it is true then it gets all calendars, if false it will check from calendar setting to know which calendar will be shown

Returns:

List List of GroupCalendarData

Throws:

java.lang.Exception

See Also:

GroupCalendarData

getCalendarCategory

CalendarCategory getCalendarCategory(java.lang.String username,
                                     java.lang.String calendarCategoryId)
                                     throws java.lang.Exception

The method gets the calendar category by given id

Parameters:

username - current user name

calendarCategoryId - id of calendar category

Returns:

CalendarCategory

Throws:

java.lang.Exception

See Also:

CalendarCategory

saveCalendarCategory

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

Save details of category for a user

Parameters:

username - current user name(or user id)

calendarCategory - the object that contains category details

isNew - the boolean value to point out that add new category or update

Throws:

java.lang.Exception

removeCalendarCategory

CalendarCategory removeCalendarCategory(java.lang.String username,
                                        java.lang.String calendarCategoryId)
                                        throws java.lang.Exception

The method used for removing one category by id

Parameters:

username - current user name(or user id)

calendarCategoryId - given category id

Returns:

Throws:

java.lang.Exception

See Also:

CalendarCategory

getUserCalendar

Calendar getUserCalendar(java.lang.String username,
                         java.lang.String calendarId)
                         throws java.lang.Exception

The method get private calendar by given calendarId, and all calendar related to this category will be removed

Parameters:

username - current user name(or user id)

calendarId - given calendar id

Returns:

Calendar object returned contains details of a calendar

Throws:

java.lang.Exception

See Also:

Calendar

getUserCalendars

java.util.List<Calendar> getUserCalendars(java.lang.String username,
                                          boolean isShowAll)
                                          throws java.lang.Exception

The method queries all private calendars of current user

Parameters:

username - current user name(or user id)

isShowAll - boolean value if equals true will get all private calendars, equals false it will take only the calendars in current user's setting

Returns:

List of calendar object

Throws:

java.lang.Exception

See Also:

Calendar

getUserCalendarsByCategory

java.util.List<Calendar> getUserCalendarsByCategory(java.lang.String username,
                                                    java.lang.String calendarCategoryId)
                                                    throws java.lang.Exception

The method look up all private calendars by given category id

Parameters:

username - current user name(or user id)

calendarCategoryId - given calendar category id

Returns:

List calendar object

Throws:

java.lang.Exception

See Also:

Calendar

saveUserCalendar

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

The method saves private calendar informations in to data base

Parameters:

username - current user name(or user id)

calendar - object contains informations

isNew - Boolean value to know add new calendar or update informations only

Throws:

java.lang.Exception

removeUserCalendar

Calendar removeUserCalendar(java.lang.String username,
                            java.lang.String calendarId)
                            throws java.lang.Exception

Remove private calendar by given id, all events and tasks belong to this calendar will be removed

Parameters:

username - current user name(or user id)

calendarId - given calendar id

Returns:

Throws:

java.lang.Exception

saveSharedCalendar

void saveSharedCalendar(java.lang.String username,
                        Calendar calendar)
                        throws java.lang.Exception

The method save all informations about shared calendar, it will be updated original calendar

Parameters:

username - current user name(or user id)

calendar - the object contains informations

Throws:

java.lang.Exception

getGroupCalendar

Calendar getGroupCalendar(java.lang.String calendarId)
                          throws java.lang.Exception

The method gets all calendar of a group user, we called it is group calendar it means the calendar for group of users and depend on the permission the user will have right to view or edit that calendar

Parameters:

calendarId - given calendar id

Returns:

Calendar object contains informations

Throws:

java.lang.Exception

See Also:

Calendar

getGroupCalendars

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

The method gets all the group calendar data of current user and list of calendars belong to that group with group calendar data it will classify calendar to each group

Parameters:

groupIds - The group IDs that current user belong

isShowAll - Gets all calendar or use setting from calendar setting

username - current user name(or user id)

Returns:

List of GroupCalendarData and each GroupCalendarData contains List of calendar object too

Throws:

java.lang.Exception

See Also:

GroupCalendarData

savePublicCalendar

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

The method save calendar to public area (group calendar)

Parameters:

calendar -

isNew - Boolean value will be checked is it add new or update informations only

username - current user name(or user id)

Throws:

java.lang.Exception

removePublicCalendar

Calendar removePublicCalendar(java.lang.String calendarId)
                              throws java.lang.Exception

Remove the group calendar form data base, every events, tasks inside this calendar will be removed too

Parameters:

calendarId -

Returns:

Throws:

java.lang.Exception

getEventCategories

java.util.List<EventCategory> getEventCategories(java.lang.String username)
                                                 throws java.lang.Exception

The method gets all categories of event

Parameters:

username - current user name(or user id)

Returns:

List event category object

Throws:

java.lang.Exception

See Also:

EventCategory

saveEventCategory

void saveEventCategory(java.lang.String username,
                       EventCategory eventCategory,
                       java.lang.String[] values,
                       boolean isNew)
                       throws java.lang.Exception

Save event category to data base, every user will have their own category to classify events, and it will use unique name in data base

Parameters:

username - current user name(or user id)

eventCategory -

values -

isNew -

Throws:

java.lang.Exception

removeEventCategory

void removeEventCategory(java.lang.String username,
                         java.lang.String eventCategoryName)
                         throws java.lang.Exception

Remove event category, all events and tasks belong to this category will be destroyed

Parameters:

username - current user name(or user id)

eventCategoryName - The unique name of category

Throws:

java.lang.Exception

getEventCategory

EventCategory getEventCategory(java.lang.String username,
                               java.lang.String eventCategoryId)
                               throws java.lang.Exception

The method gets category of event by given id

Parameters:

userSession - The session of current logged in user

username - current user name(or user id)

eventCategoryId - given event category id

Returns:

event category object contents informations

Throws:

java.lang.Exception

See Also:

EventCategory

getUserEventByCalendar

java.util.List<CalendarEvent> getUserEventByCalendar(java.lang.String username,
                                                     java.util.List<java.lang.String> calendarIds)
                                                     throws java.lang.Exception

The method gets list events and tasks of given private calendar IDs

Parameters:

userSession - The session of current logged in user

username - current user name(or user id)

calendarIds - given calendar IDs

Returns:

List of events and tasks

Throws:

java.lang.Exception

getUserEvents

java.util.List<CalendarEvent> getUserEvents(java.lang.String username,
                                            EventQuery eventQuery)
                                            throws java.lang.Exception

The method gets all events and tasks by given conditions in event query

Parameters:

userSession - The session of current logged in user

username - current user name(or user id)

eventQuery - given conditions

Returns:

List of CalendarEvent object (events and tasks)

Throws:

java.lang.Exception

See Also:

CalendarEvent

getEvent

CalendarEvent getEvent(java.lang.String username,
                       java.lang.String eventId)
                       throws java.lang.Exception

Get a personal event for a given owner

Parameters:

owner - user id of the event owner

eventId - id of event to get

Returns:

CalendarEvent in the personal events of owner

Throws:

java.lang.Exception

saveUserEvent

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

The method save information to an event or a task by given private calendar id to data

Parameters:

username - current user name(or user id)

calendarId - given calendar id

event - object contains informations

isNew - boolean value, is update or add new event

Throws:

java.lang.Exception

removeUserEvent

CalendarEvent removeUserEvent(java.lang.String username,
                              java.lang.String calendarId,
                              java.lang.String eventId)
                              throws java.lang.Exception

Remove given event or task in private calendar with calendar id, all attachments and reminders will be removed

Parameters:

username - current user name(or user id)

calendarId - given calendar id

eventId - given event id

Returns:

Throws:

java.lang.Exception

getGroupEvent

CalendarEvent getGroupEvent(java.lang.String calendarId,
                            java.lang.String eventId)
                            throws java.lang.Exception

The method gets event or task form group calendar by given calendar id

Parameters:

calendarId - given calendar id

eventId - given event id

Returns:

CalendarEvent object contains informations and attachments, reminders

Throws:

java.lang.Exception

See Also:

CalendarEvent

getGroupEventByCalendar

java.util.List<CalendarEvent> getGroupEventByCalendar(java.util.List<java.lang.String> calendarIds)
                                                      throws java.lang.Exception

The method gets events and tasks by given public calendar IDs

Parameters:

calendarIds - public calendar IDs

Returns:

List calendar event object

Throws:

java.lang.Exception

See Also:

CalendarEvent

getPublicEvents

java.util.List<CalendarEvent> getPublicEvents(EventQuery eventQuery)
                                              throws java.lang.Exception

The method gets events and tasks by given event query

Parameters:

eventQuery - object contains given conditions

Returns:

List calendar event object

Throws:

java.lang.Exception

See Also:

CalendarEvent

savePublicEvent

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

Save event or task by given group calendar id

Parameters:

calendarId - given calendar id

event - object contains information about event

isNew - boolean value to check update or add new event

Throws:

java.lang.Exception

removePublicEvent

CalendarEvent removePublicEvent(java.lang.String calendarId,
                                java.lang.String eventId)
                                throws java.lang.Exception

Remove event or task, all attachments and reminders item will be removed

Parameters:

calendarId - given calendar id

eventId - given event or task id

Returns:

Throws:

java.lang.Exception

saveCalendarSetting

void saveCalendarSetting(java.lang.String username,
                         CalendarSetting setting)
                         throws java.lang.Exception

This method stores individual setting of each user, with setting you can configuration many things like Default view date, time formating, time interval

Parameters:

username - current user name(or user id)

setting - Object contains informations about setting

Throws:

java.lang.Exception

getCalendarSetting

CalendarSetting getCalendarSetting(java.lang.String username)
                                   throws java.lang.Exception

This method gets informations of current user's setting

Parameters:

username - current user name(or user id)

Returns:

Throws:

java.lang.Exception

See Also:

CalendarSetting

getCalendarImportExports

CalendarImportExport getCalendarImportExports(java.lang.String type)

The method gets Import/Export implement class to import or export ICS,CSV

Parameters:

type - type of import, export, it supports two types, ICS and CSV

Returns:

CalendarImportExport

See Also:

CalendarImportExport

getExportImportType

java.lang.String[] getExportImportType()
                                       throws java.lang.Exception

The method gets types of data will be imported and exported

Returns:

types of import/export

Throws:

java.lang.Exception

generateRss

int generateRss(java.lang.String username,
                java.util.LinkedHashMap<java.lang.String,Calendar> calendars,
                RssData rssData)
                throws java.lang.Exception

The method uses to make URL to contains links to subscriber calendar follows RSS stand

Parameters:

username - current user name(or user id)

calendars -

rssData - object contains informations about the RSS feed

Returns:

Throws:

java.lang.Exception

See Also:

RssData

generateRss

int generateRss(java.lang.String username,
                java.util.List<java.lang.String> calendarIds,
                RssData rssData)
                throws java.lang.Exception

The method uses to make URL to contains links to subscribe calendar follows RSS stand

Specified by:

generateRss in interface CalendarServiceLegacy

Parameters:

username - current user name(or user id)

calendars -

rssData - object contains informations about the RSS feed

Returns:

Throws:

java.lang.Exception

See Also:

RssData

getFeeds

java.util.List<FeedData> getFeeds(java.lang.String username)
                                  throws java.lang.Exception

It gets data form server and show the URL to view contents of RSS

Parameters:

systemSession - session to access the public data

username - current user name(or user id)

Returns:

List of FeedData

Throws:

java.lang.Exception

See Also:

FeedData

getRssHome

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

The method return root of RSS data store area

Parameters:

username - current user name(or user id)

Returns:

Throws:

java.lang.Exception

searchEvent

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

The method query events and tasks form given conditions, the conditions know by set value for eventquery

Parameters:

userSession - The session of current logged in user

username - current user name(or user id)

eventQuery - object contains conditions to query

publicCalendarIds - public calendar IDs

Returns:

Throws:

java.lang.Exception

See Also:

EventPageList

searchHightLightEvent

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

The method query all events, tasks and mark to highlight the date have events or tasks

Parameters:

userSession - The session of current logged in user

username - current user name(or user id)

eventQuery - object contains conditions to query

publicCalendarIds - publicCalendarIds public calendar IDs

Returns:

Throws:

java.lang.Exception

shareCalendar

void shareCalendar(java.lang.String username,
                   java.lang.String calendarId,
                   java.util.List<java.lang.String> receiverUsers)
                   throws java.lang.Exception

The method share the private calendar to other user, it can share for one or many users

Parameters:

systemSession - session to access the public data

username - current user name(or user id)

calendarId - given calendar id

receiverUsers - List receive user user name or id

Throws:

java.lang.Exception

getSharedCalendars

GroupCalendarData getSharedCalendars(java.lang.String username,
                                     boolean isShowAll)
                                     throws java.lang.Exception

The method gets all shared calendars of the current user

Parameters:

systemSession - session to access the public data

username - current user name(or user id)

isShowAll - boolean value to point out that it will get all calendars or use user's clendar setting

Returns:

Throws:

java.lang.Exception

See Also:

GroupCalendarData

getEvents

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

The method selects all the events and tasks by given conditions, it includes events of private, public and share calendars

Parameters:

username - current user name(or user id)

eventQuery - given conditions

publicCalendarIds - public calendar IDs

Returns:

Throws:

java.lang.Exception

See Also:

CalendarEvent

removeSharedCalendar

void removeSharedCalendar(java.lang.String username,
                          java.lang.String calendarId)
                          throws java.lang.Exception

Removed shared calendar, but not the original calendar

Parameters:

username - current user name(or user id)

calendarId - given calendar id

Throws:

java.lang.Exception

saveEventToSharedCalendar

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

Add event to shared calendar, mean add event to original calendar too

Parameters:

username - current user name(or user id)

calendarId - given calendar id

event - object contains informations about event

isNew - boolean value to check that add new or update event

Throws:

java.lang.Exception

checkFreeBusy

java.util.Map<java.lang.String,java.lang.String> checkFreeBusy(EventQuery eventQuery)
                                                               throws java.lang.Exception

The method will check the time free or busy of the user, it depends on events and tasks of this user now it only check on one day and if the events and tasks marked with busy, out side status will be checked

Parameters:

eventQuery - The query object it contains query statement to look up the data

Returns:

Map data with key is user name (or user id), and value is the a pair of from time and to time by miliseconds and sperate by coma(,)

Throws:

java.lang.Exception

See Also:

EventQuery

generateCalDav

int generateCalDav(java.lang.String username,
                   java.util.LinkedHashMap<java.lang.String,Calendar> calendars,
                   RssData rssData)
                   throws java.lang.Exception

The method generate links to access calendar throw WEBDAV, it will require user name and password when access

Parameters:

username - current user name(or user id)

calendars - List calendar IDs will look up and public

rssData - Object contains informations about RSS feed

Returns:

Throws:

java.lang.Exception

generateCalDav

int generateCalDav(java.lang.String username,
                   java.util.List<java.lang.String> calendarIds,
                   RssData rssData)
                   throws java.lang.Exception

The method generate links to access calendar throw WEBDAV, it will require user name and password when access

Specified by:

generateCalDav in interface CalendarServiceLegacy

Parameters:

username - current user name(or user id)

calendars - List calendar IDs will look up and public

rssData - Object contains informations about RSS feed

Returns:

Throws:

Exce

java.lang.Exception

removeSharedEvent

void removeSharedEvent(java.lang.String username,
                       java.lang.String calendarId,
                       java.lang.String eventId)
                       throws java.lang.Exception

The method removes the events or tasks form shared calendar, original item will be removed

Parameters:

username - current user name(or user id)

calendarId - given calendar id

eventId - given event id

Throws:

java.lang.Exception

moveEvent

void moveEvent(java.lang.String formCalendar,
               java.lang.String toCalendar,
               java.lang.String formType,
               java.lang.String toType,
               java.util.List<CalendarEvent> calEvents,
               java.lang.String username)
               throws java.lang.Exception

The method move and save events form private calendars share calendars public calendars each other

Parameters:

formCalendar - the source calendar id

toCalendar - destination calendar id

formType - type of source calendar

toType - type of destination calendar

calEvents - List of object contains informations

username - current user name(or user id)

Throws:

java.lang.Exception

confirmInvitation

void confirmInvitation(java.lang.String fromUserId,
                       java.lang.String toUserId,
                       int calType,
                       java.lang.String calendarId,
                       java.lang.String eventId,
                       int answer)
                       throws java.lang.Exception

The method calls when the user use exo mail product only, when user receives an invitation (in the same data system), the user will confirm that do they want to take part in or not

Parameters:

fromUserId - id or user name of the user, who make the invitation

toUserId - receiver user's id or name

calType - type of calendar contains the event

calendarId - given calendar id

eventId - given event id

answer - The answer of the receive user

Throws:

java.lang.Exception

confirmInvitation

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

Throws:

java.lang.Exception

addListenerPlugin

void addListenerPlugin(CalendarUpdateEventListener listener)
                       throws java.lang.Exception

Throws:

java.lang.Exception

updateRss

void updateRss(java.lang.String usename,
               java.lang.String calendarId,
               CalendarImportExport imp)
               throws java.lang.Exception

The method update exited RSS data when calendar has been changed

Parameters:

usename -

calendarId - calendar id Added from 1.3

Throws:

java.lang.Exception

updateRss

void updateRss(java.lang.String usename,
               java.lang.String calendarId,
               CalendarImportExport imp,
               int number)
               throws java.lang.Exception

Throws:

java.lang.Exception

updateCalDav

void updateCalDav(java.lang.String usename,
                  java.lang.String calendarId,
                  CalendarImportExport imp)
                  throws java.lang.Exception

The method update exited RSS data when calendar has been changed

Parameters:

usename -

calendarId - calendar id Added from 1.3

Throws:

java.lang.Exception

updateCalDav

void updateCalDav(java.lang.String usename,
                  java.lang.String calendarId,
                  CalendarImportExport imp,
                  int number)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getTypeOfCalendar

int getTypeOfCalendar(java.lang.String userName,
                      java.lang.String calendarId)
                      throws java.lang.Exception

Throws:

java.lang.Exception