Interface ShipmentList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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

    Modifier and Type
    Method
    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 Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

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