OSID Logo
OSID Specifications
recipe package
Version 3.1.0
Interfaceosid.recipe.ProcedureList
Implementsosid.OsidList
Used Byosid.recipe.Direction
osid.recipe.ProcedureCookbookSession
osid.recipe.ProcedureLookupSession
osid.recipe.ProcedureQuerySession
osid.recipe.ProcedureSearchResults
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.Procedure the next Procedure in this list. The hasNext() method should be used to test that a next Procedure is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.