| Interface | osid.relationship.RelationshipSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing relationship searches. | ||
| Method | searchAmongRelationships | ||
| Description |
Execute this search among the given list of relationships. | ||
| Parameters | osid.id.IdList | relationshipIds | list of relationships |
| Errors | NULL_ARGUMENT | relationshipIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderRelationshipResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.relationship.RelationshipSearchOrder | relationshipSearchOrder | relationship search order |
| Errors | NULL_ARGUMENT | relationshipSearchOrder is null | |
| UNSUPPORTED | relationshipSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipSearchRecord | ||
| Description |
Gets the relationship search record corresponding to
the given relationship search record | ||
| Parameters | osid.type.Type | relationshipSearchRecordType | a relationship search record type |
| Return | osid.relationship.records.RelationshipSearchRecord | the relationship search record | |
| Errors | NULL_ARGUMENT | relationshipSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(relationshipSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |