org.osid.calendaring.batch

Interface CalendarBatchFormList

All Superinterfaces:

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

public interface CalendarBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            CalendarBatchForm form = cbfl.getNextCalendarBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            CalendarBatchForm[] forms = cbfl.getNextCalendarBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
CalendarBatchForm	getNextCalendarBatchForm() Gets the next CalendarBatchForm in this list.
CalendarBatchForm[]	getNextCalendarBatchForms(long n) Gets the next set of CalendarBatchForm 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

getNextCalendarBatchForm

CalendarBatchForm getNextCalendarBatchForm()
                                           throws OperationFailedException

Gets the next CalendarBatchForm in this list.

Returns:

the next CalendarBatchForm in this list. The hasNext() method should be used to test that a next CalendarBatchForm 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.

getNextCalendarBatchForms

CalendarBatchForm[] getNextCalendarBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

an array of CalendarBatchForm 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.