Interface WarehouseList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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());
}

Like all OsidLists, WarehouseList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • 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.