org.jasig.portlet.calendar.adapter
Interface ICalendarAdapter

All Known Implementing Classes:

AbstractCalendarAdapter, CalDavCalendarAdapter, ConfigurableFileCalendarAdapter, ConfigurableHttpCalendarAdapter, ExchangeCalendarAdapter

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

String	getDescriptionKey() Get the message key to be used as the description for this adapter.
CalendarEventSet	getEvents(CalendarConfiguration calendar, org.joda.time.Interval interval, javax.portlet.PortletRequest request) Get events for the defined calendar and time period.
String	getLink(CalendarConfiguration calendar, org.joda.time.Interval interval, javax.portlet.PortletRequest request) Get hyper link for the defined calendar.
List<org.jasig.portlet.form.parameter.Parameter>	getParameters() Get the list of configuration parameters available for this adapter.
String	getTitleKey() Get the message key to be used as the title for this adapter.

Method Detail

getTitleKey

String getTitleKey()

Get the message key to be used as the title for this adapter.

Returns:

getDescriptionKey

String getDescriptionKey()

Get the message key to be used as the description for this adapter.

Returns:

getParameters

List<org.jasig.portlet.form.parameter.Parameter> getParameters()

Get the list of configuration parameters available for this adapter.

Returns:

getEvents

CalendarEventSet getEvents(CalendarConfiguration calendar,
                           org.joda.time.Interval interval,
                           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

getLink

String getLink(CalendarConfiguration calendar,
               org.joda.time.Interval interval,
               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