org.osid.configuration.rules

Interface ParameterProcessorList

All Superinterfaces:

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

public interface ParameterProcessorList
extends OsidList

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

       
       
       while (ppl.hasNext()) {
            ParameterProcessor = ppl.getNextParameterProcessor();
       }
       
                   
       
  

or

       
       
       while (ppl.hasNext()) {
            ParameterProcessor[] = ppl.getNextParameterProcessors(ppl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextParameterProcessor

ParameterProcessor getNextParameterProcessor()
                                             throws OperationFailedException

Gets the next ParameterProcessor in this list.

Returns:

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

getNextParameterProcessors

ParameterProcessor[] getNextParameterProcessors(long n)
                                                throws OperationFailedException

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

Parameters:

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

Returns:

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