OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntrySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetJournalEntries
Description

Gets the journal entry list resulting from a search.

Returnosid.journaling.JournalEntryListthe journal entry list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntryQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.journaling.JournalEntryQueryInspectorthe journal entry query inspector
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntrySearchResultsRecord
Description

Gets the journal entry search results record corresponding to the given journal entry search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypejournalEntrySearchRecordTypea journal entry search record type
Returnosid.journaling.records.JournalEntrySearchResultsRecordthe journal entry search results record
ErrorsNULL_ARGUMENT journalEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.