Interface | osid.resource.ResourceSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getResources | ||
Description |
Gets the resource list resulting from a search. | ||
Return | osid.resource.ResourceList | the resource list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.resource.ResourceQueryInspector | the resource query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceSearchResultsRecord | ||
Description |
Gets the resource search results record corresponding
to the given resource search record | ||
Parameters | osid.type.Type | resourceSearchRecordType | a resource search record type |
Return | osid.resource.records.ResourceSearchResultsRecord | the resource search results record | |
Errors | NULL_ARGUMENT | resourceSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(resourceSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |