org.osid.calendaring.batch

Interface ScheduleBatchFormList

All Superinterfaces:

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

public interface ScheduleBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            ScheduleBatchForm form = sbfl.getNextScheduleBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            ScheduleBatchForm[] forms = sbfl.getNextScheduleBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextScheduleBatchForm

ScheduleBatchForm getNextScheduleBatchForm()
                                           throws OperationFailedException

Gets the next ScheduleBatchForm in this list.

Returns:

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

getNextScheduleBatchForms

ScheduleBatchForm[] getNextScheduleBatchForms(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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