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

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

                     
                     
                     while (pnl.hasNext()) {
                          ProfileNode node = pnl.getNextProfileNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pnl.hasNext()) {
                          ProfileNode[] nodes = pnl.getNextProfileNodes(pnl.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileNode
Description

Gets the next ProfileNode in this list.

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

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

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