OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalSearch
Implementsosid.OsidSearch
Description

The search interface for governing journal searches.

MethodsearchAmongJournals
Description

Execute this search among the given list of journals.

Parametersosid.id.IdListjournalIdslist of journals
ErrorsNULL_ARGUMENT journalIds is null
CompliancemandatoryThis method must be implemented.
MethodorderJournalResults
Description

Specify an ordering to the search results.

Parametersosid.journaling.JournalSearchOrderjournalSearchOrderjournal search order
ErrorsNULL_ARGUMENT journalSearchOrder is null
UNSUPPORTED journalSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJournalSearchRecord
Description

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

Parametersosid.type.TypejournalSearchRecordTypea journal search record type
Returnosid.journaling.records.JournalSearchRecordthe journal search record
ErrorsNULL_ARGUMENT journalSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalSearchRecordType) is false
CompliancemandatoryThis method must be implemented.