OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalEntrySearchResults
Implementsosid.OsidSearchResults
Used Byosid.journaling.JournalEntrySearchSession
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.JournalEntryList the journal entry list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetJournalEntryQueryInspector
Description

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

Returnosid.journaling.JournalEntryQueryInspector the journal entry query inspector
Compliancemandatory This 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.TypejournalEntrySearchRecordType a journal entry search record type
Returnosid.journaling.records.JournalEntrySearchResultsRecord the journal entry search results record
ErrorsNULL_ARGUMENT journalEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(journalEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.