org.osid.billing.batch

Interface PeriodBatchFormList

All Superinterfaces:

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

public interface PeriodBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PeriodBatchForm form = pbfl.getNextPeriodBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PeriodBatchForm[] forms = pbfl.getNextPeriodBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPeriodBatchForm

PeriodBatchForm getNextPeriodBatchForm()
                                       throws OperationFailedException

Gets the next PeriodBatchForm in this list.

Returns:

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

getNextPeriodBatchForms

PeriodBatchForm[] getNextPeriodBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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