OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalSearchResults
Implementsosid.OsidSearchResults
Used Byosid.journaling.JournalSearchSession
Description

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

MethodgetJournals
Description

Gets the journal list resulting from a search.

Returnosid.journaling.JournalList the journal list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetJournalQueryInspector
Description

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

Returnosid.journaling.JournalQueryInspector the journal query inspector
Compliancemandatory This method must be implemented.
MethodgetJournalSearchResultsRecord
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.

Parametersosid.type.TypejournalSearchRecordType a journal search record type
Returnosid.journaling.records.JournalSearchResultsRecord the journal search results record
ErrorsNULL_ARGUMENT JournalSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(journalSearchRecordType) is false
Compliancemandatory This method must be implemented.