OSID Logo
OSID Specifications
recipe package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recipe.ProcedureList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Procedure procedure = pl.getNextProcedure();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Procedure[] procedures = pl.getNextProcedures(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProcedure
Description

Gets the next Procedure in this list.

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

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

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