org.osid.ordering.batch

Interface StoreBatchFormList

All Superinterfaces:

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

public interface StoreBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            StoreBatchForm form = sbfl.getNextStoreBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            StoreBatchForm[] forms = sbfl.getNextStoreBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextStoreBatchForm

StoreBatchForm getNextStoreBatchForm()
                                     throws OperationFailedException

Gets the next StoreBatchForm in this list.

Returns:

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

getNextStoreBatchForms

StoreBatchForm[] getNextStoreBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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