OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ControllerList
Implementsosid.OsidList
Used Byosid.control.ControllerLookupSession
osid.control.ControllerQuerySession
osid.control.ControllerSearchResults
osid.control.ControllerSystemSession
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.Controller the next Controller in this list. The hasNext() method should be used to test that a next Controller is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.