OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
journaling package
Version 3.0.0
Release Candidate Preview
| Interface | osid.journaling.JournalSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getJournals | ||
| Description |
Gets the journal list resulting from a search. | ||
| Return | osid.journaling.JournalList | the journal list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.journaling.JournalQueryInspector | the journal query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalSearchResultsRecord | ||
| Description |
Gets the journal search results record corresponding to the given journal search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | journalSearchRecordType | a journal search record type |
| Return | osid.journaling.records.JournalSearchResultsRecord | the journal search results record | |
| Errors | NULL_ARGUMENT | JournalSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(journalSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |