| Interface | osid.journaling.JournalEntrySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getJournalEntries | ||
| Description |
Gets the journal entry list resulting from a search. | ||
| Return | osid.journaling.JournalEntryList | the journal entry list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalEntryQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.journaling.JournalEntryQueryInspector | the journal entry query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJournalEntrySearchResultsRecord | ||
| Description |
Gets the journal entry search results record
corresponding to the given journal entry search record
| ||
| Parameters | osid.type.Type | journalEntrySearchRecordType | a journal entry search record type |
| Return | osid.journaling.records.JournalEntrySearchResultsRecord | the journal entry search results record | |
| Errors | NULL_ARGUMENT | journalEntrySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(journalEntrySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |