org.osid.acknowledgement.batch

Interface CreditBatchFormList

All Superinterfaces:

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

public interface CreditBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            CreditBatchForm form = cbfl.getNextCreditBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            CreditBatchForm[] forms = cbfl.getNextCreditBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCreditBatchForm

CreditBatchForm getNextCreditBatchForm()
                                       throws OperationFailedException

Gets the next CreditBatchForm in this list.

Returns:

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

getNextCreditBatchForms

CreditBatchForm[] getNextCreditBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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