edu.yale.its.tp.portlets.calendar.adapter
Interface ICalendarAdapter

All Known Implementing Classes:

CalDavCalendarAdapter, ConfigurableFileCalendarAdapter, ConfigurableHttpCalendarAdapter

public interface ICalendarAdapter

ICalendarAdapter defines an interface for retrieving calendar event data. All new calendar types must define an adapter using this interface, then be registered in the spring context files.

Author:

Jen Bourey

Method Summary

java.util.Set<CalendarEvent>	getEvents(CalendarConfiguration calendar, net.fortuna.ical4j.model.Period period, javax.servlet.http.HttpServletRequest request) Get events for the defined calendar and time period.
java.util.Set<CalendarEvent>	getEvents(CalendarConfiguration calendar, net.fortuna.ical4j.model.Period period, javax.portlet.PortletRequest request) Get events for the defined calendar and time period.
java.lang.String	getLink(CalendarConfiguration calendar, net.fortuna.ical4j.model.Period period, javax.portlet.PortletRequest request) Get hyper link for the defined calendar.

Method Detail

getEvents

java.util.Set<CalendarEvent> getEvents(CalendarConfiguration calendar,
                                       net.fortuna.ical4j.model.Period period,
                                       javax.portlet.PortletRequest request)
                                       throws CalendarException

Get events for the defined calendar and time period. The user's PortletRequest is made available to give the calendar adapter access to useful information such as the UserInfo map, session data, etc. These items can be used to identify the user, provide access to authentication resources, or other useful operations.

Parameters:

calendar - calendar configuration for which to retrieve events

period - time period for which to retrieve events

request - user's portlet request

Returns:

Set of events for this calendar and time period

Throws:

CalendarException

getEvents

java.util.Set<CalendarEvent> getEvents(CalendarConfiguration calendar,
                                       net.fortuna.ical4j.model.Period period,
                                       javax.servlet.http.HttpServletRequest request)
                                       throws CalendarException

Get events for the defined calendar and time period. The user's HttpServletRequest is made available to give the calendar adapter access to useful information such as the request parameters, session data, etc. These items can be used to identify the user, provide access to authentication resources, or other useful operations.

Parameters:

calendar - calendar configuration for which to retrieve events

period - time period for which to retrieve events

request - user's servlet request

Returns:

Set of events for this calendar and time period

Throws:

CalendarException

getLink

java.lang.String getLink(CalendarConfiguration calendar,
                         net.fortuna.ical4j.model.Period period,
                         javax.portlet.PortletRequest request)
                         throws CalendarLinkException

Get hyper link for the defined calendar. In cases where the calendar resource has a web interface, this method allows provides access to the url.

Parameters:

calendar - calendar configuration for which to retrieve events

period - time period for which to retrieve events

request - user's servlet request

Returns:

Set of events for this calendar and time period

Throws:

CalendarException

CalendarLinkException