OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.ActionEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ael.hasNext()) {
                          ActionEnabler enabler = ael.getNextActionEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ael.hasNext()) {
                          ActionEnabler[] enablers = ael.getNextActionEnablers(ael.available());
                     }
                     
                                 
                     
                
MethodgetNextActionEnabler
Description

Gets the next ActionEnabler in this list.

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

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

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