OSID - osid.calendaring.cycle.CyclicEventList Service Interface Definition

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