OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalEntrySearch
Implementsosid.OsidSearch
Used Byosid.journaling.JournalEntrySearchSession
Description

The search interface for governing journal entry searches.

MethodsearchAmongJournalEntries
Description

Execute this search among the given list of journal entries.

Parametersosid.id.IdListjournalEntryIds list of journal entries
ErrorsNULL_ARGUMENT journalEntryIds is null
Compliancemandatory This method must be implemented.
MethodorderJournalEntryResults
Description

Specify an ordering to the search results.

Parametersosid.journaling.JournalEntrySearchOrderjournalEntrySearchOrder journal entry search order
ErrorsNULL_ARGUMENT journalEntrySearchOrder is null
UNSUPPORTED journalEntrySearchOrder is not of this service
Compliancemandatory This 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.TypejournalEntrySearchRecordType a journal entry search record type
Returnosid.journaling.records.JournalEntrySearchRecord the journal entry search record
ErrorsNULL_ARGUMENT journalEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(journalEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.