OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.ResourceRelationshipList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rrl.hasNext()) {
                          ResourceRelationship relationship = rrl.getNextResourceRelationship();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rrl.hasNext()) {
                          ResourceRelationship[] relationships = rrl.getNextResourceRelationships(rrl.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceRelationship
Description

Gets the next ResourceRelationship in this list.

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

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

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