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

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

                     
                     
                     while (sl.hasNext()) {
                          Step step = sl.getNextStep();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Step[] steps = sl.getNextSteps(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextStep
Description

Gets the next Step in this list.

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

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

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