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

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

                     
                     
                     while (pel.hasNext()) {
                          ProfileEntry entry = pel.getNextProfileEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pel.hasNext()) {
                          ProfileEntry[] entries = pel.getNextProfileEntries(pel.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileEntry
Description

Gets the next ProfileEntry in this list.

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

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

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