OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SettingList
Implementsosid.OsidList
Used Byosid.control.Scene
osid.control.SettingLookupSession
osid.control.SettingQuerySession
osid.control.SettingSearchResults
osid.control.SettingSystemSession
osid.control.Trigger
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.Setting the next Setting in this list. The hasNext() method should be used to test that a next Setting 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.
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().

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