OSID Logo
OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.FamilyNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fnl.hasNext()) {
                          FamilyNode node = fnl.getNextFamilyNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fnl.hasNext()) {
                          FamilyNode[] nodes = fnl.getNextFamilyNodes(fnl.available());
                     }
                     
                                 
                     
                
MethodgetNextFamilyNode
Description

Gets the next FamilyNode in this list.

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

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

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