org.osid.journaling.batch

Interface BranchBatchFormList

All Superinterfaces:

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

public interface BranchBatchFormList
extends OsidList

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

       
       
       while (bbfl.hasNext()) {
            BranchBatchForm form = bbfl.getNextBranchBatchForm();
       }
       
                   
       
  

or

       
       
       while (bbfl.hasNext()) {
            BranchBatchForm[] forms = bbfl.getNextBranchBatchForms(bbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBranchBatchForm

BranchBatchForm getNextBranchBatchForm()
                                       throws OperationFailedException

Gets the next BranchBatchForm in this list.

Returns:

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

getNextBranchBatchForms

BranchBatchForm[] getNextBranchBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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