Interface ICalendarEventProvider
- All Known Implementing Classes:
CalendarEventProvider
public interface ICalendarEventProvider
A provider than gathers a set of calendar events and
exposes them as a list of ICalendarEvent object
Alternately, if a start and end date are supplied, the event
list is limited to those entries that fall within the date range.
-
Method Summary
Modifier and TypeMethodDescriptionGet a list of calendar events returned by this provider.void
setEndDate
(Date endDate) Set the end date for the date range for this provider Setting the date to null, clears the end date.void
setStartDate
(Date startDate) Set the start date of the date range for this provider.
-
Method Details
-
getEventList
List<ICalendarEvent> getEventList()Get a list of calendar events returned by this provider. If the start date and end date are not defined then the entire list is returned. Otherwise a list of calendar events that occur after the start date and before the end date are returned.- Returns:
- A list of calendar events for this provider.
-
setStartDate
Set the start date of the date range for this provider. Setting the date to null, clears the start date.- Parameters:
startDate
- Include events that occur after this date.
-
setEndDate
Set the end date for the date range for this provider Setting the date to null, clears the end date.- Parameters:
endDate
- Include events that occur before this date.
-