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

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

                     
                     
                     while (al.hasNext()) {
                          Action action = al.getNextAction();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Action[] actions = al.getNextActions(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAction
Description

Gets the next Action in this list.

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

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

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