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

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

                     
                     
                     while (rl.hasNext()) {
                          Relationship relationship = rl.getNextRelationship();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rl.hasNext()) {
                          Relationship[] relationships = rl.getNextRelationships(rl.available());
                     }
                     
                                 
                     
                
MethodgetNextRelationship
Description

Gets the next Relationship in this list.

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

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

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