org.osid.billing.payment.batch

Interface PayerBatchFormList

All Superinterfaces:

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

public interface PayerBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PayerBatchForm form = pbfl.getNextPayerBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PayerBatchForm[] forms = pbfl.getNextPayerBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPayerBatchForm

PayerBatchForm getNextPayerBatchForm()
                                     throws OperationFailedException

Gets the next PayerBatchForm in this list.

Returns:

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

getNextPayerBatchForms

PayerBatchForm[] getNextPayerBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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