OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextStepProcessor
Description

Gets the next StepProcessor in this list.

Returnosid.workflow.rules.StepProcessorthe next StepProcessor in this list. The hasNext() method should be used to test that a next StepProcessor is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextStepProcessors
Description

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

Parameterscardinalnthe number of StepProcessor elements requested which must be less than or equal to available()
Returnosid.workflow.rules.StepProcessor[]an array of StepProcessor elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.