org.osid.inventory

Interface WarehouseNodeList

All Superinterfaces:

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

public interface WarehouseNodeList
extends OsidList

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

       
       
       while (wnl.hasNext()) {
            WarehouseNode node = wnl.getNextWarehouseNode();
       }
       
                   
       
  

or

       
       
       while (wnl.hasNext()) {
            WarehouseNode[] nodes = wnl.getNextWarehouseNodes(wnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextWarehouseNode

WarehouseNode getNextWarehouseNode()
                                   throws OperationFailedException

Gets the next WarehouseNode in this list.

Returns:

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

getNextWarehouseNodes

WarehouseNode[] getNextWarehouseNodes(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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