| Interface | osid.calendaring.cycle.CyclicEventList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (cel.hasNext()) {
CyclicEvent event = cel.getNextCyclicEvent();
}
or
while (cel.hasNext()) {
CyclicEvent[] events = cel.getNextCyclicEvents(cel.available());
}
| ||
| Method | getNextCyclicEvent | ||
| Description |
Gets the next | ||
| 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 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextCyclicEvents | ||
| Description |
Gets the next set of | ||
| 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 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |