org.osid.relationship.batch

Interface FamilyBatchFormList

All Superinterfaces:

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

public interface FamilyBatchFormList
extends OsidList

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

       
       
       while (fbfl.hasNext()) {
            FamilyBatchForm form = fbfl.getNextFamilyBatchForm();
       }
       
                   
       
  

or

       
       
       while (fbfl.hasNext()) {
            FamilyBatchForm[] forms = fbfl.getNextFamilyBatchForms(fbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextFamilyBatchForm

FamilyBatchForm getNextFamilyBatchForm()
                                       throws OperationFailedException

Gets the next FamilyBatchForm in this list.

Returns:

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

getNextFamilyBatchForms

FamilyBatchForm[] getNextFamilyBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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