org.osid.ordering

Interface CostList

All Superinterfaces:

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

public interface CostList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Cost cost = cl.getNextCost();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Cost[] costs = cl.getNextCosts(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCost

Cost getNextCost()
                 throws OperationFailedException

Gets the next Cost in this list.

Returns:

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

getNextCosts

Cost[] getNextCosts(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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