OSID Specifications
journaling package
Version 3.1.0
journaling package
Version 3.1.0
| Interface | osid.journaling.JournalSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCatalogSearchOrder | ||
| Used By | osid.journaling.JournalSearchSession | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | getJournalSearchOrderRecord | ||
| Description |
Gets the journal search order record corresponding to the given journal record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | journalRecordType | a journal record type |
| Return | osid.journaling.records.JournalSearchOrderRecord | the journal search order record | |
| Errors | NULL_ARGUMENT | journalRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(journalRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |