| Interface | osid.recipe.DirectionSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing direction searches. | ||
| Method | searchAmongDirections | ||
| Description |
Execute this search among the given list of directions. | ||
| Parameters | osid.id.IdList | directionIds | list of directions |
| Errors | NULL_ARGUMENT | directionIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderDirectionResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.recipe.DirectionSearchOrder | directionSearchOrder | direction search order |
| Errors | NULL_ARGUMENT | directionSearchOrder is null | |
| UNSUPPORTED | directionSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getDirectionSearchRecord | ||
| Description |
Gets the direction search record corresponding to the
given direction search record | ||
| Parameters | osid.type.Type | directionSearchRecordType | a direction search record type |
| Return | osid.recipe.records.DirectionSearchRecord | the direction search 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. | |