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

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

                     
                     
                     while (ael.hasNext()) {
                          AuthorizationEnabler enabler = ael.getNextAuthorizationEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ael.hasNext()) {
                          AuthorizationEnabler[] enablers = ael.getNextAuthorizationEnablers(ael.available());
                     }
                     
                                 
                     
                
MethodgetNextAuthorizationEnabler
Description

Gets the next AuthorizationEnabler in this list.

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

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

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