org.osid.control

Interface InputList

All Superinterfaces:

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

public interface InputList
extends OsidList

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

       
       
       while (il.hasNext()) {
            Input input = il.getNextInput();
       }
       
                   
       
  

or

       
       
       while (il.hasNext()) {
            Input[] inputs = il.getNextInputs(il.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextInput

Input getNextInput()
                   throws OperationFailedException

Gets the next Input in this list.

Returns:

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

getNextInputs

Input[] getNextInputs(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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