OSID Logo
OSID Specifications
profile package
Version 3.1.0
Interfaceosid.profile.ProfileNodeList
Implementsosid.OsidList
Used Byosid.profile.ProfileNode
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.ProfileNode the next ProfileNode in this list. The hasNext() method should be used to test that a next ProfileNode is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.