Interface | osid.mapping.path.IntersectionSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getIntersections | ||
Description |
Gets the intersection list resulting from a search. | ||
Return | osid.mapping.path.IntersectionList | the intersection list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.mapping.path.IntersectionQueryInspector | the intersection query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionSearchResultsRecord | ||
Description |
Gets the intersection search results record
corresponding to the given intersection search record
| ||
Parameters | osid.type.Type | intersectionSearchRecordType | a intersection search record type |
Return | osid.mapping.path.records.IntersectionSearchResultsRecord | the intersection search results record | |
Errors | NULL_ARGUMENT | intersectionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(intersectionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |