OSID - osid.calendaring.RecurringEventList Service Interface Definition

Interface	osid.calendaring.RecurringEventList
Implements	`osid.OsidList`
Used By	`osid.calendaring.RecurringEventCalendarSession`
	`osid.calendaring.RecurringEventLookupSession`
	`osid.calendaring.RecurringEventQuerySession`
	`osid.calendaring.RecurringEventSearchResults`
	`osid.calendaring.RecurringEventUnravellingSession`
	`osid.calendaring.rules.RecurringEventEnablerRuleLookupSession`
Description	Like all `OsidLists`, `RecurringEventList` provides a means for accessing `RecurringEvent` elements sequentially either one at a time or many at a time. Examples: while (rel.hasNext()) { RecurringEvent event = rel.getNextRecurringEvent(); } or while (rel.hasNext()) { RecurringEvent[] events = rel.getNextRecurringEvents(rel.available()); }
Method	getNextRecurringEvent
Description	Gets the next `RecurringEvent` in this list.
Return	`osid.calendaring.RecurringEvent`		the next `RecurringEvent` in this list. The `hasNext()` method should be used to test that a next `RecurringEvent` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextRecurringEvents
Description	Gets the next set of `RecurringEvent` elements in this list which must be less than or equal to the number returned from `available()`.
Parameters	`cardinal`	`n`	the number of `RecurringEvent` elements requested which should be less than or equal to `available()`
Return	`osid.calendaring.RecurringEvent[]`		an array of `RecurringEvent` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.