org.sakaiproject.calendaring.api

Interface ExternalCalendaringService

public interface ExternalCalendaringService

A service to provide integrations with external calendars using the iCalendar standard.

Tools and services can leverage this to generate an ICS file for an event, as well as make updates. Ref: http://www.ietf.org/rfc/rfc2445.txt

Author:

Steve Swinsburg (steve.swinsburg@gmail.com)

Method Summary

Modifier and Type	Method and Description
net.fortuna.ical4j.model.component.VEvent	addAttendeesToEvent(net.fortuna.ical4j.model.component.VEvent vevent, Set<User> attendees) Adds a list of attendees to an existing VEvent.
net.fortuna.ical4j.model.component.VEvent	addChairAttendeesToEvent(net.fortuna.ical4j.model.component.VEvent vevent, Set<User> attendees) Adds a list of attendees to an existing VEvent with the chair role.
net.fortuna.ical4j.model.component.VEvent	cancelEvent(net.fortuna.ical4j.model.component.VEvent vevent) Set the status of an existing VEvent to cancelled.
net.fortuna.ical4j.model.Calendar	createCalendar(List<net.fortuna.ical4j.model.component.VEvent> events) Creates an iCal calendar from a list of VEvents.
net.fortuna.ical4j.model.Calendar	createCalendar(List<net.fortuna.ical4j.model.component.VEvent> events, String method, boolean timeIsLocal) Creates an iCal calendar from a list of VEvents with a specified method.
net.fortuna.ical4j.model.component.VEvent	createEvent(CalendarEvent event) Creates an iCal VEvent for a Sakai CalendarEvent.
net.fortuna.ical4j.model.component.VEvent	createEvent(CalendarEvent event, Set<User> attendees) Creates an iCal VEvent for a Sakai CalendarEvent with the given attendees.
net.fortuna.ical4j.model.component.VEvent	createEvent(CalendarEvent event, Set<User> attendees, boolean timeIsLocal) Creates an iCal VEvent for a Sakai CalendarEvent with the given attendees.
boolean	isIcsEnabled() Is the ICS service enabled?
String	toFile(net.fortuna.ical4j.model.Calendar calendar) Write an iCal calendar out to a file in the filesystem and return the path.

Method Detail

createEvent

net.fortuna.ical4j.model.component.VEvent createEvent(CalendarEvent event)

Creates an iCal VEvent for a Sakai CalendarEvent. This must then be turned into a Calendar before it can be turned into an ICS file.
If the CalendarEvent has the field 'vevent_uuid', that will be used as the UUID of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_sequence', that will be used as the sequence of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_url', that will be added to the URL property of the VEvent.

Parameters:

event - Sakai CalendarEvent

Returns:

the VEvent for the given event or null if there was an error

createEvent

net.fortuna.ical4j.model.component.VEvent createEvent(CalendarEvent event,
                                                      Set<User> attendees)

Creates an iCal VEvent for a Sakai CalendarEvent with the given attendees. This must then be turned into a Calendar before it can be turned into an ICS file.
If the CalendarEvent has the field 'vevent_uuid', that will be used as the UUID of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_sequence', that will be used as the sequence of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_url', that will be added to the URL property of the VEvent.

Parameters:

event - Sakai CalendarEvent

attendees - set of Users that have been invited to the event

Returns:

the VEvent for the given event or null if there was an error

createEvent

net.fortuna.ical4j.model.component.VEvent createEvent(CalendarEvent event,
                                                      Set<User> attendees,
                                                      boolean timeIsLocal)

Creates an iCal VEvent for a Sakai CalendarEvent with the given attendees. This must then be turned into a Calendar before it can be turned into an ICS file.
If the CalendarEvent has the field 'vevent_uuid', that will be used as the UUID of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_sequence', that will be used as the sequence of the VEvent preferentially.
If the CalendarEvent has the field 'vevent_url', that will be added to the URL property of the VEvent.

Parameters:

event - Sakai CalendarEvent

attendees - set of Users that have been invited to the event

Returns:

the VEvent for the given event or null if there was an error

addAttendeesToEvent

net.fortuna.ical4j.model.component.VEvent addAttendeesToEvent(net.fortuna.ical4j.model.component.VEvent vevent,
                                                              Set<User> attendees)

Adds a list of attendees to an existing VEvent. This must then be turned into a Calendar before it can be turned into an ICS file.

Parameters:

vevent - The VEvent to add the attendess too

attendees - set of Users that have been invited to the event

Returns:

the VEvent for the given event or null if there was an error

addChairAttendeesToEvent

net.fortuna.ical4j.model.component.VEvent addChairAttendeesToEvent(net.fortuna.ical4j.model.component.VEvent vevent,
                                                                   Set<User> attendees)

Adds a list of attendees to an existing VEvent with the chair role. This must then be turned into a Calendar before it can be turned into an ICS file.

Parameters:

vevent - The VEvent to add the attendess too

attendees - set of Users that will chair the event

Returns:

the VEvent for the given event or null if there was an error

cancelEvent

net.fortuna.ical4j.model.component.VEvent cancelEvent(net.fortuna.ical4j.model.component.VEvent vevent)

Set the status of an existing VEvent to cancelled. This must then be turned into a Calendar before it can be turned into an ICS file.

Parameters:

vevent - The VEvent to cancel

Returns:

the updated VEvent

createCalendar

net.fortuna.ical4j.model.Calendar createCalendar(List<net.fortuna.ical4j.model.component.VEvent> events)

Creates an iCal calendar from a list of VEvents. timeIsLocal is set to true so it returns a local timezone element

Parameters:

events - iCal VEvents

Returns:

the Calendar for the given events or null if there was an error

createCalendar

net.fortuna.ical4j.model.Calendar createCalendar(List<net.fortuna.ical4j.model.component.VEvent> events,
                                                 String method,
                                                 boolean timeIsLocal)

Creates an iCal calendar from a list of VEvents with a specified method.

Parameters:

events - iCal VEvents

method - the ITIP method for the calendar, e.g. "REQUEST"

Returns:

the Calendar for the given events or null if there was an error

toFile

String toFile(net.fortuna.ical4j.model.Calendar calendar)

Write an iCal calendar out to a file in the filesystem and return the path.

Parameters:

calendar - iCal calendar object

Returns:

the path to the file

isIcsEnabled

boolean isIcsEnabled()

Is the ICS service enabled? Tools can use this public method for test in their own UIs. If this is disabled, nothing will be generated.

Returns: