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

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

                     
                     
                     while (rl.hasNext()) {
                          Rule rule = rl.getNextRule();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Rule[] rules = rl.getNextRules(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRule
Description

Gets the next Rule in this list.

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

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

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