OSID - osid.calendaring.TimePeriodList Service Interface Definition

Interface	osid.calendaring.TimePeriodList
Implements	`osid.OsidList`
Used By	`osid.calendaring.TimePeriodCalendarSession`
	`osid.calendaring.TimePeriodLookupSession`
	`osid.calendaring.TimePeriodQuerySession`
	`osid.calendaring.TimePeriodSearchResults`
	`osid.calendaring.cycle.TimePeriodCyclicTimePeriodLookupSession`
Description	Like all `OsidLists`, `TimePeriodList` provides a means for accessing `TimePeriod` elements sequentially either one at a time or many at a time. Examples: while (tp.hasNext()) { TimePeriod period = tp.getNextTimePeriod(); } or while (tp.hasNext()) { TimePeriod[] periods = tp.getNextTimePeriods(tp.available()); }
Method	getNextTimePeriod
Description	Gets the next `TimePeriod` in this list.
Return	`osid.calendaring.TimePeriod`		the next `TimePeriod` in this list. The `hasNext()` method should be used to test that a next `TimePeriod` 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	getNextTimePeriods
Description	Gets the next set of `TimePeriod` elements in this list which must be less than or equal to the number returned from `available()`.
Parameters	`cardinal`	`n`	the number of `TimePeriod` elements requested which should be less than or equal to `available()`
Return	`osid.calendaring.TimePeriod[]`		an array of `TimePeriod` 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.