Interface | osid.resource.ResourceRelationshipSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getResourceRelationships | ||
Description |
Gets the resource relationship list resulting from the search. | ||
Return | osid.resource.ResourceRelationshipList | the resource relationship list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceRelationshipQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.resource.ResourceRelationshipQueryInspector | the resource relationship query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceRelationshipSearchResultsRecord | ||
Description |
Gets the resource relationship search results record
corresponding to the given resource relationship search
record | ||
Parameters | osid.type.Type | resourceRelationshipSearchRecordType | a resource relationship search record type |
Return | osid.resource.records.ResourceRelationshipSearchResultsRecord | the resource relationship search results record | |
Errors | NULL_ARGUMENT | resourceRelationshipSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(resourceRelationshipSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |