OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.ActionEnablerList
Implementsosid.OsidList
Used Byosid.control.rules.ActionEnablerLookupSession
osid.control.rules.ActionEnablerQuerySession
osid.control.rules.ActionEnablerRuleLookupSession
osid.control.rules.ActionEnablerSearchResults
osid.control.rules.ActionEnablerSystemSession
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.ActionEnabler the next ActionEnabler in this list. The hasNext() method should be used to test that a next ActionEnabler is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.