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

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

                     
                     
                     while (cnl.hasNext()) {
                          CookbookNode node = cnl.getNextCookbookNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cnl.hasNext()) {
                          CookbookNode[] nodes = cnl.getNextCookbookNodes(cnl.available());
                     }
                     
                                 
                     
                
MethodgetNextCookbookNode
Description

Gets the next CookbookNode in this list.

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

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

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