org.osid.calendaring.cycle.batch

Interface CyclicTimePeriodBatchFormList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface CyclicTimePeriodBatchFormList
extends OsidList

Like all OsidLists, CyclicTimePeriodBatchFormList provides a means for accessing CyclicTimePeriodBatchForm elements sequentially either one at a time or many at a time. Examples:

       
       
       while (ctpbfl.hasNext()) {
            CyclicTimePeriodBatchForm form = ctpbfl.getNextCyclicTimePeriodBatchForm();
       }
       
                   
       
  

or

       
       
       while (ctpbfl.hasNext()) {
            CyclicTimePeriodBatchForm[] forms = ctpbfl.getNextCyclicTimePeriodBatchForms(ctpbfl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
CyclicTimePeriodBatchForm	getNextCyclicTimePeriodBatchForm() Gets the next CyclicTimePeriodBatchForm in this list.
CyclicTimePeriodBatchForm[]	getNextCyclicTimePeriodBatchForms(long n) Gets the next set of CyclicTimePeriodBatchForm elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextCyclicTimePeriodBatchForm

CyclicTimePeriodBatchForm getNextCyclicTimePeriodBatchForm()
                                                           throws OperationFailedException

Gets the next CyclicTimePeriodBatchForm in this list.

Returns:

the next CyclicTimePeriodBatchForm in this list. The hasNext() method should be used to test that a next CyclicTimePeriodBatchForm is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextCyclicTimePeriodBatchForms

CyclicTimePeriodBatchForm[] getNextCyclicTimePeriodBatchForms(long n)
                                                              throws OperationFailedException

Gets the next set of CyclicTimePeriodBatchForm elements in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of CyclicTimePeriodBatchForm elements requested which must be less than or equal to available()

Returns:

an array of CyclicTimePeriodBatchForm elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.