org.exoplatform.calendar.service
Interface CalendarImportExport

All Known Implementing Classes:

CsvImportExport, ICalendarImportExport

public interface CalendarImportExport

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

Method Summary

java.io.OutputStream	exportCalendar(java.lang.String username, java.util.List<java.lang.String> calendarIds, java.lang.String type) The method exports events form calendar to icalendar file (.ics) or .csv file
java.io.OutputStream	exportCalendar(java.lang.String username, java.util.List<java.lang.String> calendarIds, java.lang.String type, int number)
java.io.OutputStream	exportEventCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession, java.lang.String username, java.lang.String calendarId, java.lang.String type, java.lang.String eventId) The method export calendar event to output stream by given event id
java.util.List<CalendarEvent>	getEventObjects(java.io.InputStream icalInputStream) The method maps the input stream to event object
void	importCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession, java.lang.String username, java.io.InputStream icalInputStream, java.lang.String calendarName) The method imports events form icalendar(.ics) or outlook calendar exported .csv file to the system
void	importToCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession, java.lang.String username, java.io.InputStream icalInputStream, java.lang.String calendarId) The method imports events form icalendar(.ics) or outlook calendar exported .csv file to the system
boolean	isValidate(java.io.InputStream icalInputStream) The method return true if the input stream is correct format

Method Detail

importCalendar

void importCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession,
                    java.lang.String username,
                    java.io.InputStream icalInputStream,
                    java.lang.String calendarName)
                    throws java.lang.Exception

The method imports events form icalendar(.ics) or outlook calendar exported .csv file to the system

Parameters:

userSession - session of current user

username - current user name or id

icalInputStream - data input stream

calendarName - given calendar name, if the name is null, default calendar name is file name

Throws:

java.lang.Exception

importToCalendar

void importToCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession,
                      java.lang.String username,
                      java.io.InputStream icalInputStream,
                      java.lang.String calendarId)
                      throws java.lang.Exception

The method imports events form icalendar(.ics) or outlook calendar exported .csv file to the system

Parameters:

userSession - session of current user

username - current user name or id

icalInputStream - data input stream

calendarId - given existed calendar id

Throws:

java.lang.Exception

exportCalendar

java.io.OutputStream exportCalendar(java.lang.String username,
                                    java.util.List<java.lang.String> calendarIds,
                                    java.lang.String type)
                                    throws java.lang.Exception

The method exports events form calendar to icalendar file (.ics) or .csv file

Parameters:

username - current user name or id

calendarIds - the group calendar ids, if you want to export events from public calendars

type - The type of calendar will be exported

Returns:

data output stream

Throws:

java.lang.Exception

exportCalendar

java.io.OutputStream exportCalendar(java.lang.String username,
                                    java.util.List<java.lang.String> calendarIds,
                                    java.lang.String type,
                                    int number)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

exportEventCalendar

java.io.OutputStream exportEventCalendar(org.exoplatform.services.jcr.ext.common.SessionProvider userSession,
                                         java.lang.String username,
                                         java.lang.String calendarId,
                                         java.lang.String type,
                                         java.lang.String eventId)
                                         throws java.lang.Exception

The method export calendar event to output stream by given event id

Parameters:

userSession - session of current user

username - current user name or id

calendarId - given calendar id, the calendar event belong to

type - The type of calendar will be exported

eventId - given event id

Returns:

data output stream

Throws:

java.lang.Exception

getEventObjects

java.util.List<CalendarEvent> getEventObjects(java.io.InputStream icalInputStream)
                                              throws java.lang.Exception

The method maps the input stream to event object

Parameters:

icalInputStream - the input stream

Returns:

List of calendar event objects contant infomations

Throws:

java.lang.Exception

isValidate

boolean isValidate(java.io.InputStream icalInputStream)
                   throws java.lang.Exception

The method return true if the input stream is correct format

Parameters:

icalInputStream - the input stream

Throws:

java.lang.Exception