Interface | osid.relationship.RelationshipSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRelationships | ||
Description |
Gets the relationship list resulting from a search. | ||
Return | osid.relationship.RelationshipList | the relationship list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.relationship.RelationshipQueryInspector | the relationship query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipSearchResultsRecord | ||
Description |
Gets the relationship search results record
corresponding to the given relationship search record
| ||
Parameters | osid.type.Type | relationshipSearchRecordType | a relationship search record type |
Return | osid.relationship.records.RelationshipSearchResultsRecord | the relationship search results 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. |