org.osid.control

Interface ControllerList

All Superinterfaces:

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

public interface ControllerList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Controller controller = cl.getNextController();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Controller[] controllers = cl.getNextControllers(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextController

Controller getNextController()
                             throws OperationFailedException

Gets the next Controller in this list.

Returns:

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

getNextControllers

Controller[] getNextControllers(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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