OSID Specifications
relationship package
Version 3.0.0
Release Candidate Preview
relationship package
Version 3.0.0
Release Candidate Preview
| Interface | osid.relationship.RelationshipQuery | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipQuery | ||
| Description |
This is the query for searching relationships. Each method
match specifies an | ||
| Method | matchSourceId | ||
| Description |
Matches a relationship peer. | ||
| Parameters | osid.id.Id | peer | peer Id to match |
boolean | match | true for a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | peer is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearSourceIdTerms | ||
| Description |
Clears the peer | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchDestinationId | ||
| Description |
Matches the other relationship peer. | ||
| Parameters | osid.id.Id | peer | peer Id to match |
boolean | match | true for a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | peer is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearDestinationIdTerms | ||
| Description |
Clears the other peer | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchSamePeerId | ||
| Description |
Matches circular relationships to the same peer. | ||
| Parameters | boolean | match | true for a positive match, false for a
negative match |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearSamePeerIdTerms | ||
| Description |
Clears the same peer | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | matchFamilyId | ||
| Description |
Sets the family | ||
| Parameters | osid.id.Id | familyId | a family Id |
boolean | match | true for a positive match, false for a
negative match | |
| Errors | NULL_ARGUMENT | familyId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | clearFamilyIdTerms | ||
| Description |
Clears the family | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsFamilyQuery | ||
| Description |
Tests if a | ||
| Return | boolean | true if a family query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilyQuery | ||
| Description |
Gets the query for a family. Multiple retrievals
produce a nested | ||
| Return | osid.relationship.FamilyQuery | the family query | |
| Errors | UNIMPLEMENTED | supportsFamilyQuery() is false | |
| Compliance | optional | This method must be implemented if supportsFamilyQuery() is
true. | |
| Method | clearFamilyTerms | ||
| Description |
Clears the family terms. | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipQueryRecord | ||
| Description |
Gets the relationship query record corresponding to the
given | ||
| Parameters | osid.type.Type | relationshipRecordType | a relationship record type |
| Return | osid.relationship.records.RelationshipQueryRecord | the relationship query record | |
| Errors | NULL_ARGUMENT | relationshipRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(relationshipRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |