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

The search interface for governing journal entry searches.

MethodsearchAmongJournalEntries
Description

Execute this search among the given list of journal entries.

Parametersosid.id.IdListjournalEntryIdslist of journal entries
ErrorsNULL_ARGUMENT journalEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderJournalEntryResults
Description

Specify an ordering to the search results.

Parametersosid.journaling.JournalEntrySearchOrderjournalEntrySearchOrderjournal entry search order
ErrorsNULL_ARGUMENT journalEntrySearchOrder is null
UNSUPPORTED journalEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntrySearchRecord
Description

Gets the journal entry search 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.JournalEntrySearchRecordthe journal entry search record
ErrorsNULL_ARGUMENT journalEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(journalEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.