| Interface | osid.calendaring.cycle.batch.CyclicTimePeriodBatchFormList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all
while (ctpbfl.hasNext()) {
CyclicTimePeriodBatchForm form = ctpbfl.getNextCyclicTimePeriodBatchForm();
}
or
while (ctpbfl.hasNext()) {
CyclicTimePeriodBatchForm[] forms = ctpbfl.getNextCyclicTimePeriodBatchForms(ctpbfl.available());
}
| ||
| Method | getNextCyclicTimePeriodBatchForm | ||
| Description |
Gets the next | ||
| Return | osid.calendaring.cycle.batch.CyclicTimePeriodBatchForm | the next CyclicTimePeriodBatchForm in this list. The
hasNext() method should be used to test that a next
CyclicTimePeriodBatchForm 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 | getNextCyclicTimePeriodBatchForms | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of CyclicTimePeriodBatchForm elements requested
which must be less than or equal to available() |
| Return | osid.calendaring.cycle.batch.CyclicTimePeriodBatchForm[] | an array of CyclicTimePeriodBatchForm 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. | |