| Interface | osid.calendaring.TimePeriodList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (tp.hasNext()) {
TimePeriod period = tp.getNextTimePeriod();
}
or
while (tp.hasNext()) {
TimePeriod[] periods = tp.getNextTimePeriods(tp.available());
}
| ||
| Method | getNextTimePeriod | ||
| Description |
Gets the next | ||
| 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 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextTimePeriods | ||
| Description |
Gets the next set of | ||
| 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 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |