com.stratelia.webactiv.almanach.control.ejb
Interface EventOccurrenceGenerator

All Known Implementing Classes:

ICal4JEventOccurrencesGenerator

public interface EventOccurrenceGenerator

Generator of occurrences of one or more events in a given window in time.

Method Summary

List<EventOccurrence>	generateOccurrencesFrom(com.silverpeas.calendar.Date date, List<EventDetail> events) Generates the occurrences of the specified events that occur from the specified date with no limit in the future.
List<EventOccurrence>	generateOccurrencesInPeriod(org.silverpeas.date.Period period, List<EventDetail> events) Generates the occurrences of events that occur in the specified period.
List<EventOccurrence>	generateOccurrencesInRange(com.silverpeas.calendar.Date startDate, com.silverpeas.calendar.Date endDate, List<EventDetail> events) Generates the occurrences of the specified events that occur between the two specified dates.

Method Detail

generateOccurrencesInPeriod

List<EventOccurrence> generateOccurrencesInPeriod(org.silverpeas.date.Period period,
                                                  List<EventDetail> events)

Generates the occurrences of events that occur in the specified period.

Parameters:

period - the period in which occurrences of events occur.

events - the events for which the occurrences have to be generated.

Returns:

a list of occurrences occuring in the specified period

generateOccurrencesInRange

List<EventOccurrence> generateOccurrencesInRange(com.silverpeas.calendar.Date startDate,
                                                 com.silverpeas.calendar.Date endDate,
                                                 List<EventDetail> events)

Generates the occurrences of the specified events that occur between the two specified dates.

Parameters:

startDate - the inclusive date from which the event occurrences occur.

endDate - the date to which the event occurrences occur.

events - the events for which the occurrences have to be generated.

Returns:

a list of occurrences occuring from the specified date.

generateOccurrencesFrom

List<EventOccurrence> generateOccurrencesFrom(com.silverpeas.calendar.Date date,
                                              List<EventDetail> events)

Generates the occurrences of the specified events that occur from the specified date with no limit in the future.

Parameters:

date - the inclusive date from which the event occurrences occur.

events - the events for which the occurrences have to be generated.

Returns:

a list of occurrences occuring from the specified date.