org.osid.inventory.shipment.batch

Interface EntryBatchFormList

All Superinterfaces:

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

public interface EntryBatchFormList
extends OsidList

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

       
       
       while (ebfl.hasNext()) {
            EntryBatchForm form = ebfl.getNextEntryBatchForm();
       }
       
                   
       
  

or

       
       
       while (ebfl.hasNext()) {
            EntryBatchForm[] forms = ebfl.getNextEntryBatchForms(ebfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextEntryBatchForm

EntryBatchForm getNextEntryBatchForm()
                                     throws OperationFailedException

Gets the next EntryBatchForm in this list.

Returns:

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

getNextEntryBatchForms

EntryBatchForm[] getNextEntryBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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