org.osid.inquiry

Interface InquestList

All Superinterfaces:

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

public interface InquestList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Inquest inquest = il.getNextInquest();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Inquest[] inquests = il.getNextInquests(il.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInquest

Inquest getNextInquest()
                       throws OperationFailedException

Gets the next Inquest in this list.

Returns:

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

getNextInquests

Inquest[] getNextInquests(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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