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

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

                     
                     
                     while (cl.hasNext()) {
                          Check check = cl.getNextCheck();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Check[] checks = cl.getNextChecks(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCheck
Description

Gets the next Check in this list.

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

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

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