OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.FunctionList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fl.hasNext()) {
                          Function function = fl.getNextFunction();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fl.hasNext()) {
                          Function[] functions = fl.getNextFunctions(fl.available());
                     }
                     
                                 
                     
                
MethodgetNextFunction
Description

Gets the next Function in this list.

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

Gets the next set of Function elements in this list which must be less than or equal to the number returned from available().

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