OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalEntrySearchSession
Implementsosid.journaling.JournalEntryQuerySession
Description

This session provides methods for searching JournalEntry objects. The search query is constructed using the JournalEntryQuery. The journal record Type also specifies the record for the journal query.

getJournalEntriesByQuery() is the basic search method and returns a list of Journal elements. A more advanced search may be performed with getJournalEntriesBySearch(). It accepts a JournalEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getJournalEntriesBySearch() returns a JournalEntrySearchResults that can be used to access the resulting JournalEntryList or be used to perform a search within the result set through JournalEntrySearch.

Journal entries may have a query record indicated by their respective record types. The query record is accessed via the JournalEntryQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetJournalEntrySearch
Description

Gets a journal entry search.

Returnosid.journaling.JournalEntrySearchthe journal entry search
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntrySearchOrder
Description

Gets a journal entry search order. The JournalEntrySearchOrder is supplied to a JournalEntrySearch to specify the ordering of results.

Returnosid.journaling.JournalEntrySearchOrderthe journal entry search order
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesBySearch
Description

Gets the search results matching the given search.

Parametersosid.journaling.JournalEntryQueryjournalEntryQuerythe journal entry query
osid.journaling.JournalEntrySearchjournalEntrySearchthe journal entry search
Returnosid.journaling.JournalEntrySearchResultsthe search results
ErrorsNULL_ARGUMENT journalEntryQuery or journalEntrySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED journalEntryQuery or journalEntrySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntryQueryFromInspector
Description

Gets a journal entry query from an inspector. The inspector is available from a JournalEntrySearchResults.

Parametersosid.journaling.JournalEntryQueryInspectorjournalEntryQueryInspectora journal entry query inspector
Returnosid.journaling.JournalEntryQuerythe journal entry query
ErrorsNULL_ARGUMENT journalEntryQueryInspector is null
UNSUPPORTED journalEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.