org.osid.inventory

Interface WarehouseList

All Superinterfaces:

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

public interface WarehouseList
extends OsidList

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

       
       
       while (wl.hasNext()) {
            Warehouse warehouse = wl.getNextWarehouse();
       }
       
                   
       
  

or

       
       
       while (wl.hasNext()) {
            Warehouse[] warehouses = wl.getNextWarehouses(wl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextWarehouse

Warehouse getNextWarehouse()
                           throws OperationFailedException

Gets the next Warehouse in this list.

Returns:

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

getNextWarehouses

Warehouse[] getNextWarehouses(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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