OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.EngineNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (enl.hasNext()) {
                          EngineNode node = enl.getNextEngineNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (enl.hasNext()) {
                          EngineNode[] nodes = enl.getNextEngineNodes(enl.available());
                     }
                     
                                 
                     
                
MethodgetNextEngineNode
Description

Gets the next EngineNode in this list.

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

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

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