OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.RepositoryNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rnl.hasNext()) {
                          RepositoryNode node = rnl.getNextRepositoryNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rnl.hasNext()) {
                          RepositoryNode[] nodes = rnl.getNextRepositoryNodes(rnl.available());
                     }
                     
                                 
                     
                
MethodgetNextRepositoryNode
Description

Gets the next RepositoryNode in this list.

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

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

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