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

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

                     
                     
                     while (ppl.hasNext()) {
                          ParameterProcessor = ppl.getNextParameterProcessor();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppl.hasNext()) {
                          ParameterProcessor[] = ppl.getNextParameterProcessors(ppl.available());
                     }
                     
                                 
                     
                
MethodgetNextParameterProcessor
Description

Gets the next ParameterProcessor in this list.

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

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

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