Interface | osid.calendaring.cycle.CyclicTimePeriodList | ||
---|---|---|---|
Implements | osid.OsidList | ||
Description |
Like all while (ctpl.hasNext()) { CyclicTimePeriod period = ctpl.getNextCyclicTimePeriod(); }or while (ctpl.hasNext()) { CyclicTimePeriod[] periods = ctpl.getNextCyclicTimePeriods(ctpl.available()); } | ||
Method | getNextCyclicTimePeriod | ||
Description |
Gets the next | ||
Return | osid.calendaring.cycle.CyclicTimePeriod | the next CyclicTimePeriod in this list. The hasNext()
method should be used to test that a next CyclicTimePeriod
is available before calling this method. | |
Errors | ILLEGAL_STATE | no more elements available in this list | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getNextCyclicTimePeriods | ||
Description |
Gets the next set of | ||
Parameters | cardinal | n | the number of CyclicTimePeriod elements requested which
should be less than or equal to available() |
Return | osid.calendaring.cycle.CyclicTimePeriod[] | an array of CyclicTimePeriod 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 | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |