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

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

                     
                     
                     while (sl.hasNext()) {
                          Setting setting = sl.getNextSetting();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Setting[] settings = sl.getNextSettings(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextSetting
Description

Gets the next Setting in this list.

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

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

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