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

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

                     
                     
                     while (il.hasNext()) {
                          Instruction instruction = il.getNextInstruction();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (il.hasNext()) {
                          Instruction[] instructions = il.getNextInstructions(il.available());
                     }
                     
                                 
                     
                
MethodgetNextInstruction
Description

Gets the next Instruction in this list.

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

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

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