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

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

                     
                     
                     while (spel.hasNext()) {
                          StepProcessorEnabler enabler = spel.getNextStepProcessorEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (spel.hasNext()) {
                          StepProcessorEnabler[] enablers = qpel.getNextStepProcessorEnablers(spel.available());
                     }
                     
                                 
                     
                
MethodgetNextStepProcessorEnabler
Description

Gets the next StepProcessorEnabler in this list.

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

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

Parameterscardinalnthe number of StepProcessorEnabler elements requested which must be less than or equal to available()
Returnosid.workflow.rules.StepProcessorEnabler[]an array of StepProcessorEnabler 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.