Interface | osid.recipe.DirectionSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getDirections | ||
Description |
Gets the direction list resulting from a search. | ||
Return | osid.recipe.DirectionList | the direction list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.recipe.DirectionQueryInspector | the direction query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getDirectionSearchResultsRecord | ||
Description |
Gets the direction search results record corresponding
to the given direction search record | ||
Parameters | osid.type.Type | directionSearchRecordType | a direction search record type |
Return | osid.recipe.records.DirectionSearchResultsRecord | the direction search results record | |
Errors | NULL_ARGUMENT | directionSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | hasRecordType(directionSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |