OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControllerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cl.hasNext()) {
                          Controller controller = cl.getNextController();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Controller[] controllers = cl.getNextControllers(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextController
Description

Gets the next Controller in this list.

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

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

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