| Interface | osid.mapping.path.IntersectionSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing intersection searches. | ||
| Method | searchAmongIntersections | ||
| Description |
Execute this search among the given list of intersections. | ||
| Parameters | osid.id.IdList | intersectionIds | list of intersections |
| Errors | NULL_ARGUMENT | intersectionIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIntersectionResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.mapping.path.IntersectionSearchOrder | intersectionSearchOrder | intersection search order |
| Errors | NULL_ARGUMENT | intersectionSearchOrder is null | |
| UNSUPPORTED | intersectionSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIntersectionSearchRecord | ||
| Description |
Gets the intersection search record corresponding to
the given intersection search record | ||
| Parameters | osid.type.Type | intersectionSearchRecordType | a intersection search record type |
| Return | osid.mapping.path.records.IntersectionSearchRecord | the intersection search 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. | |