OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceRelationshipList
Implementsosid.OsidList
Used Byosid.resource.ResourceRelationshipBinSession
osid.resource.ResourceRelationshipLookupSession
osid.resource.ResourceRelationshipQuerySession
osid.resource.ResourceRelationshipSearchResults
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.ResourceRelationship the next ResourceRelationship in this list. The hasNext() method should be used to test that a next ResourceRelationship is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.