| Interface | osid.search.EngineList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description | Like all  
                     
                     
                     while (el.hasNext()) {
                          Engine engine = el.getNextEngine();
                     }
                     
                                 
                     
                or
                     
                     
                     while (el.hasNext()) {
                          Engine[] engines = el.getNextEngines(el.available());
                     }
                     
                                 
                     
                 | ||
| Method | getNextEngine | ||
| Description | Gets the next  | ||
| Return | osid.search.Engine | the next  Engine in this list. The hasNext() method should be used to test that a next Engine is available 
before calling this method. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextEngines | ||
| Description | Gets the next set of  | ||
| Parameters | cardinal | n | the number of  Engine elements requested which must be less 
than or equal to available()  | 
| Return | osid.search.Engine[] | an array of  Engine elements. The length of 
the array is less than or equal to the number specified. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |