OSID - osid.calendaring.OffsetEventList Service Interface Definition

Interface	osid.calendaring.OffsetEventList
Implements	`osid.OsidList`
Used By	`osid.calendaring.OffsetEventCalendarSession`
	`osid.calendaring.OffsetEventLookupSession`
	`osid.calendaring.OffsetEventQuerySession`
	`osid.calendaring.OffsetEventSearchResults`
	`osid.calendaring.rules.OffsetEventEnablerRuleLookupSession`
Description	Like all `OsidLists`, `OffsetEventList` provides a means for accessing `OffsetEvent` elements sequentially either one at a time or many at a time. Examples: while (oel.hasNext()) { OffsetEvent event = oel.getNextOffsetEvent(); } or while (oel.hasNext()) { OffsetEvent[] events = oel.getNextOffsetEvents(oel.available()); }
Method	getNextOffsetEvent
Description	Gets the next `OffsetEvent` in this list.
Return	`osid.calendaring.OffsetEvent`		the next `OffsetEvent` in this list. The `hasNext()` method should be used to test that a next `OffsetEvent` 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	getNextOffsetEvents
Description	Gets the next set of `OffsetEvent` elements in this list which must be less than or equal to the number returned from `available()`.
Parameters	`cardinal`	`n`	the number of `OffsetEvent` elements requested which should be less than or equal to `available()`
Return	`osid.calendaring.OffsetEvent[]`		an array of `OffsetEvent` 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.