OSID Specifications
search package
Version 3.1.0
search package
Version 3.1.0
| Interface | osid.search.EngineSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.search.EngineSearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getEngineSearchOrderRecord | ||
| Description |
Gets the engine search record order corresponding to the given engine record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | engineRecordType | an engine record type |
| Return | osid.search.records.EngineSearchOrderRecord | the engine search order record | |
| Errors | NULL_ARGUMENT | engineRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(engineRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |