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

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

                     
                     
                     while (cl.hasNext()) {
                          Cookbook cookbook = cl.getNextCookbook();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Cookbook[] cookbooks = cl.getNextCookbooks(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCookbook
Description

Gets the next Cookbook in this list.

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

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

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