OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.JournalSearchSession
Implementsosid.journaling.JournalQuerySession
Description

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

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

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

MethodgetJournalSearch
Description

Gets a journal search.

Returnosid.journaling.JournalSearchthe journal search
CompliancemandatoryThis method must be implemented.
MethodgetJournalSearchOrder
Description

Gets a journal search order. The JournalSearchOrder is supplied to a JournalSearch to specify the ordering of results.

Returnosid.journaling.JournalSearchOrderthe journal search order
CompliancemandatoryThis method must be implemented.
MethodgetJournalsBySearch
Description

Gets the search results matching the given search.

Parametersosid.journaling.JournalQueryjournalQuerythe journal query
osid.journaling.JournalSearchjournalSearchthe journal search
Returnosid.journaling.JournalSearchResultsthe journal search results
ErrorsNULL_ARGUMENT journalQuery or journalSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED journalQuery or journalSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetJournalQueryFromInspector
Description

Gets a journal query from an inspector. The inspector is available from a JournalSearchResults.

Parametersosid.journaling.JournalQueryInspectorjournalQueryInspectora journal query inspector
Returnosid.journaling.JournalQuerythe journal query
ErrorsNULL_ARGUMENT journalQueryInspector is null
UNSUPPORTED journalQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.