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

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

                     
                     
                     while (ppel.hasNext()) {
                          ParameterProcessorEnabler enabler = ppel.getNextParameterProcessorEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ppel.hasNext()) {
                          ParameterProcessorEnabler[] enablers = ppel.getNextParameterProcessorEnablers(ppel.available());
                     }
                     
                                 
                     
                
MethodgetNextParameterProcessorEnabler
Description

Gets the next ParameterProcessorEnabler in this list.

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

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

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