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

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

                     
                     
                     while (el.hasNext()) {
                          Engine engine = el.getNextEngine();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (el.hasNext()) {
                          Engine[] engines = el.getNextEngines(el.available());
                     }
                     
                                 
                     
                
MethodgetNextEngine
Description

Gets the next Engine in this list.

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

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

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