org.osid.inventory.batch

Interface ItemBatchFormList

All Superinterfaces:

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

public interface ItemBatchFormList
extends OsidList

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

       
       
       while (ibfl.hasNext()) {
            ItemBatchForm form = ibfl.getNextItemBatchForm();
       }
       
                   
       
  

or

       
       
       while (ibfl.hasNext()) {
            ItemBatchForm[] forms = ibfl.getNextItemBatchForms(ibfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextItemBatchForm

ItemBatchForm getNextItemBatchForm()
                                   throws OperationFailedException

Gets the next ItemBatchForm in this list.

Returns:

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

getNextItemBatchForms

ItemBatchForm[] getNextItemBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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