| Interface | osid.calendaring.RecurringEventList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (rel.hasNext()) {
RecurringEvent event = rel.getNextRecurringEvent();
}
or
while (rel.hasNext()) {
RecurringEvent[] events = rel.getNextRecurringEvents(rel.available());
}
| ||
| Method | getNextRecurringEvent | ||
| Description |
Gets the next | ||
| Return | osid.calendaring.RecurringEvent | the next RecurringEvent in this list. The hasNext()
method should be used to test that a next RecurringEvent
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 | getNextRecurringEvents | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of RecurringEvent elements requested which should
be less than or equal to available() |
| Return | osid.calendaring.RecurringEvent[] | an array of RecurringEvent 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. | |