org.osid.workflow.rules

Interface StepProcessorList

All Superinterfaces:

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

public interface StepProcessorList
extends OsidList

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

       
       
       while (spl.hasNext()) {
            StepProcessor processor = spl.getNextStepProcessor();
       }
       
                   
       
  

or

       
       
       while (spl.hasNext()) {
            StepProcessor[] processors  = spl.getNextStepProcessors(spl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextStepProcessor

StepProcessor getNextStepProcessor()
                                   throws OperationFailedException

Gets the next StepProcessor in this list.

Returns:

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

getNextStepProcessors

StepProcessor[] getNextStepProcessors(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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