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

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

                     
                     
                     while (il.hasNext()) {
                          Input input = il.getNextInput();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Input[] inputs = il.getNextInputs(il.available());
                     }
                     
                                 
                     
                
MethodgetNextInput
Description

Gets the next Input in this list.

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

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

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