OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Interfaceosid.workflow.rules.StepEnablerList
Implementsosid.OsidList
Used Byosid.workflow.rules.StepEnablerLookupSession
osid.workflow.rules.StepEnablerOfficeSession
osid.workflow.rules.StepEnablerQuerySession
osid.workflow.rules.StepEnablerRuleLookupSession
osid.workflow.rules.StepEnablerSearchResults
Description

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

while (sel.hasNext()) {
     StepEnabler enabler = sel.getNextStepEnabler();
}

or

while (sel.hasNext()) {
     StepEnabler[] enablers = sel.getNextStepEnablers(sel.available());
}            
                
MethodgetNextStepEnabler
Description

Gets the next StepEnabler in this list.

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

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

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