org.osid.authorization

Interface FunctionList

All Superinterfaces:

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

public interface FunctionList
extends OsidList

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

       
       
       while (fl.hasNext()) {
            Function function = fl.getNextFunction();
       }
       
                   
       
  

or

       
       
       while (fl.hasNext()) {
            Function[] functions = fl.getNextFunctions(fl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Function	getNextFunction() Gets the next Function in this list.
Function[]	getNextFunctions(long n) Gets the next set of Function elements in this list which must be less than or equal to the number returned from available().

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

getNextFunction

Function getNextFunction()
                         throws OperationFailedException

Gets the next Function in this list.

Returns:

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

getNextFunctions

Function[] getNextFunctions(long n)
                            throws OperationFailedException

Gets the next set of Function elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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