| Interface | osid.relationship.RelationshipList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Used By | osid.relationship.RelationshipFamilySession | ||
osid.relationship.RelationshipLookupSession | |||
osid.relationship.RelationshipQuerySession | |||
osid.relationship.RelationshipSearchResults | |||
osid.relationship.rules.RelationshipEnablerRuleLookupSession | |||
| Description |
Like all while (rl.hasNext()) {
Relationship relationship = rl.getNextRelationship();
}
or
while (rl.hasNext()) {
Relationship[] relationships = rl.getNextRelationships(rl.available());
}
| ||
| Method | getNextRelationship | ||
| Description |
Gets the next | ||
| Return | osid.relationship.Relationship | the next Relationship in this list. The
hasNext() method should be used to test that a next
Relationship is available before calling this method. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextRelationships | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of Relationship elements requested which must be
less than or equal to available() |
| Return | osid.relationship.Relationship[] | an array of Relationship elements. The length of the array is
less than or equal to the number specified. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |