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

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

                     
                     
                     while (cl.hasNext()) {
                          Configuration config = cl.getNextConfiguration();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Configuration[] configs = cl.getNextConfigurations(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextConfiguration
Description

Gets the next Configuration in this list.

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

Gets the next set of Configuration objects in this lis which must be less than or equal to whst is returned from available().

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