OSID - osid.calendaring.EventList Service Interface Definition

Interface	osid.calendaring.EventList
Implements	`osid.OsidList`
Used By	`osid.calendaring.EventCalendarSession`
	`osid.calendaring.EventLookupSession`
	`osid.calendaring.EventQuerySession`
	`osid.calendaring.EventSearchResults`
	`osid.calendaring.RecurringEvent`
	`osid.calendaring.RecurringEventUnravellingSession`
	`osid.calendaring.TimePeriod`
	`osid.calendaring.cycle.EventCyclicEventLookupSession`
Description	Like all `OsidLists`, `EventList` provides a means for accessing `Event` elements sequentially either one at a time or many at a time. Examples: while (el.hasNext()) { Event event = el.getNextEvent(); } or while (el.hasNext()) { Event[] events = el.getNextEvents(el.available()); }
Method	getNextEvent
Description	Gets the next `Event` in this list.
Return	`osid.calendaring.Event`		the next `Event` in this list. The `hasNext()` method should be used to test that a next `Event` 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	getNextEvents
Description	Gets the next set of `Event` elements in this list which must be less than or equal to the number returned from `available()`.
Parameters	`cardinal`	`n`	the number of `Event` elements requested which should be less than or equal to `available()`
Return	`osid.calendaring.Event[]`		an array of `Event` 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.