Package org.xwiki.contrib.moccacalendar

Interface RecurrentEventGenerator

@Role
@Unstable
public interface RecurrentEventGenerator

A generator that creates actual event instances from a given recurrent event.

Since:

2.7

Version:

$Id: $

Method Summary

Modifier and Type	Method	Description
List<EventInstance>	generate(com.xpn.xwiki.doc.XWikiDocument event, Date dateFrom, Date dateTo)	given the event document create a list of event instances happening between dateFrom and dateTo.

Method Details

generate

List<EventInstance> generate(com.xpn.xwiki.doc.XWikiDocument event,
 Date dateFrom,
 Date dateTo)

given the event document create a list of event instances happening between dateFrom and dateTo.

Parameters:

event - the document describing the recurrent event. This event is guaranteed to contain a MoccaCalendarEventRecurrencyClass object with a frequency matching the name of the generator.

dateFrom - the date after which generated event instances should end

dateTo - the date before which generated event instances should start

Returns:

a list of event instances; might be empty but should not be null