OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.OublietteNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (onl.hasNext()) {
                          OublietteNode node = onl.getNextOublietteNode(Node);
                     }
                     
                                 
                     
                
or
                     
                     
                     while (onl.hasNext()) {
                          OublietteNode[] nodes = onl.getNextOublietteNodes(onl.available());
                     }
                     
                                 
                     
                
MethodgetNextOublietteNode
Description

Gets the next OublietteNode in this list.

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

Gets the next set of OublietteNode elements in this list. The specified amount must be less than or equal to the return from available().

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