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

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

                     
                     
                     while (crl.hasNext()) {
                          CheckResult result = crl.getNextCheckResult();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (crl.hasNext()) {
                          CheckResult[] results = crl.getNextCheckResults(crl.available());
                     }
                     
                                 
                     
                
MethodgetNextCheckResult
Description

Gets the next CheckResult in this list.

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

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

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