org.osid.configuration

Interface ValueList

All Superinterfaces:

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

public interface ValueList
extends OsidList

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

       
       
       while (vl.hasNext()) {
            Value value = vl.getNextValue();
       }
       
                   
       
  

or

       
       
       while (vl.hasNext()) {
            Value[] values = vl.getNextValues(vl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Value	getNextValue() Gets the next Value in this list.
Value[]	getNextValues(long n) Gets the next set of Values in this list which must be less than or equal to the return from available().

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

getNextValue

Value getNextValue()
                   throws OperationFailedException

Gets the next Value in this list.

Returns:

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

getNextValues

Value[] getNextValues(long n)
                      throws OperationFailedException

Gets the next set of Values in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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