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

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

                     
                     
                     while (scl.hasNext()) {
                          StepConstrainer constrainer = scl.getNextStepConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (scl.hasNext()) {
                          StepConstrainer[] constrainers = scl.getNextStepConstrainers(scl.available());
                     }
                     
                                 
                     
                
MethodgetNextStepConstrainer
Description

Gets the next StepConstrainer in this list.

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

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

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