OSID Specifications
mapping path package
Version 3.1.0
mapping path package
Version 3.1.0
| Interface | osid.mapping.path.SignalSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRuleSearchOrder | ||
| Used By | osid.mapping.path.SignalSearchSession | ||
osid.mapping.path.SignalSmartMapSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByPath | ||
| Description |
Specifies a preference for ordering the results by path. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsPathSearchOrder | ||
| Description |
Tests if a search order for the path is available. | ||
| Return | boolean | true if a path search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPathSearchOrder | ||
| Description |
Gets a path search order. | ||
| Return | osid.mapping.path.PathSearchOrder | the path search order | |
| Errors | UNIMPLEMENTED | supportsPathSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsPathSearchOrder()
is true. | |
| Method | getSignalSearchOrderRecord | ||
| Description |
Gets the signal search order record corresponding to
the given signal record | ||
| Parameters | osid.type.Type | signalRecordType | a signal record type |
| Return | osid.mapping.path.records.SignalSearchOrderRecord | the signal search order record | |
| Errors | NULL_ARGUMENT | signalRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(signalRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |