org.osid.recipe

Interface ProcedureList

All Superinterfaces:

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

public interface ProcedureList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Procedure procedure = pl.getNextProcedure();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Procedure[] procedures = pl.getNextProcedures(pl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProcedure

Procedure getNextProcedure()
                           throws OperationFailedException

Gets the next Procedure in this list.

Returns:

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

getNextProcedures

Procedure[] getNextProcedures(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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