org.osid.hold

Interface OublietteList

All Superinterfaces:

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

public interface OublietteList
extends OsidList

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

       
       
       while (ol.hasNext()) {
            Oubliette oubliette = ol.getNextOubliette();
       }
       
                   
       
  

or

       
       
       while (ol.hasNext()) {
            Oubliette[] oubliettes = ol.getNextOubliettes(ol.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOubliette

Oubliette getNextOubliette()
                           throws OperationFailedException

Gets the next Oubliette in this list.

Returns:

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

getNextOubliettes

Oubliette[] getNextOubliettes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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