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

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

                     
                     
                     while (fl.hasNext()) {
                          Family family = fl.getNextFamily();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fl.hasNext()) {
                          Family[] families = fl.getNextFamilies(fl.available());
                     }
                     
                                 
                     
                
MethodgetNextFamily
Description

Gets the next Family in this list.

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

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

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