org.osid.ordering.batch

Interface PriceBatchFormList

All Superinterfaces:

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

public interface PriceBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PriceBatchForm form = pbfl.getNextPriceBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PriceBatchForm[] forms = pbfl.getNextPriceBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPriceBatchForm

PriceBatchForm getNextPriceBatchForm()
                                     throws OperationFailedException

Gets the next PriceBatchForm in this list.

Returns:

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

getNextPriceBatchForms

PriceBatchForm[] getNextPriceBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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