org.osid.inventory.shipment

Interface ShipmentList

All Superinterfaces:

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

public interface ShipmentList
extends OsidList

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

       
       
       while (sl.hasNext()) {
            Shipment shipment = sl.getNextShipment();
       }
       
                   
       
  

or

       
       
       while (sl.hasNext()) {
            Shipment[] shipments = sl.getNextShipments(sl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextShipment

Shipment getNextShipment()
                         throws OperationFailedException

Gets the next Shipment in this list.

Returns:

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

getNextShipments

Shipment[] getNextShipments(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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