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

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

                     
                     
                     while (pil.hasNext()) {
                          ProfileItem item = pil.getNextProfileItem();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pil.hasNext()) {
                          ProfileItem[] items = pil.getNextProfileItems(pil.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileItem
Description

Gets the next ProfileItem in this list.

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

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

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