org.osid.metering.batch

Interface MeterBatchFormList

All Superinterfaces:

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

public interface MeterBatchFormList
extends OsidList

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

       
       
       while (mbfl.hasNext()) {
            MeterBatchForm form = mbfl.getNextMeterBatchForm();
       }
       
                   
       
  

or

       
       
       while (mbfl.hasNext()) {
            MeterBatchForm[] forms = mbfl.getNextMeterBatchForms(mbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextMeterBatchForm

MeterBatchForm getNextMeterBatchForm()
                                     throws OperationFailedException

Gets the next MeterBatchForm in this list.

Returns:

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

getNextMeterBatchForms

MeterBatchForm[] getNextMeterBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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