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

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

                     
                     
                     while (pl.hasNext()) {
                          Profile profile = pl.getNextProfile();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Profile[] profiles = pl.getNextProfiles(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProfile
Description

Gets the next Profile in this list.

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

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

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