OSID Logo
OSID Specifications
journaling package
Version 3.1.0
Interfaceosid.journaling.JournalQuerySession
Implementsosid.OsidSession
Implemented Byosid.journaling.JournalSearchSession
Used Byosid.journaling.JournalingManager
osid.journaling.JournalingProxyManager
Description

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

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.

MethodcanSearchJournals
Description

Tests if this user can perform Journal searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetJournalQuery
Description

Gets a journal query.

Returnosid.journaling.JournalQuery the journal query
Compliancemandatory This method must be implemented.
MethodgetJournalsByQuery
Description

Gets a list of Journals matching the given search.

Parametersosid.journaling.JournalQueryjournalQuery the journal query
Returnosid.journaling.JournalList the returned JournalList
ErrorsNULL_ARGUMENT journalQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED journalQuery is not of this service
Compliancemandatory This method must be implemented.