OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ParameterList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Parameter parameter = pl.getNextParameter();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Parameter[] parameters = pl.getNextParameters(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextParameter
Description

Gets the next Parameter in this list.

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

Gets the next set of Parameters in this list which must be less than or equal to the return from available().

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