org.osid.ordering

Interface OrderList

All Superinterfaces:

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

public interface OrderList
extends OsidList

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

       
       
       while (ol.hasNext()) {
            Order order = ol.getNextOrder();
       }
       
                   
       
  

or

       
       
       while (ol.hasNext()) {
            Order[] orders = ol.getNextOrders(ol.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOrder

Order getNextOrder()
                   throws OperationFailedException

Gets the next Order in this list.

Returns:

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

getNextOrders

Order[] getNextOrders(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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