OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ValueList
Implementsosid.OsidList
Used Byosid.configuration.ValueLookupSession
osid.configuration.ValueQuerySession
osid.configuration.ValueRetrievalSession
osid.configuration.ValueSearchResults
osid.configuration.rules.ValueEnablerRuleLookupSession
Description

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

while (vl.hasNext()) {
     Value value = vl.getNextValue();
}
                
or
while (vl.hasNext()) {
     Value[] values = vl.getNextValues(vl.available());
}
                
MethodgetNextValue
Description

Gets the next Value in this list.

Returnosid.configuration.Value the next Value in this list. The hasNext() method should be used to test that a next Value 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.
MethodgetNextValues
Description

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

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