OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pel.hasNext()) {
                          ProfileEntryEnabler enabler = pel.getNextProfileEntryEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pel.hasNext()) {
                          ProfileEntryEnabler[] enablers = pel.getNextProfileEntryEnablers pel.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileEntryEnabler
Description

Gets the next ProfileEntryEnabler in this list.

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

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

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