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

This session provides methods for searching Journal objects. 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
CompliancemandatoryThis method must be implemented.
MethodgetJournalQuery
Description

Gets a journal query.

Returnosid.journaling.JournalQuerythe journal query
CompliancemandatoryThis method must be implemented.
MethodgetJournalsByQuery
Description

Gets a list of Journals matching the given search.

Parametersosid.journaling.JournalQueryjournalQuerythe journal query
Returnosid.journaling.JournalListthe returned JournalList
ErrorsNULL_ARGUMENT journalQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED journalQuery is not of this service
CompliancemandatoryThis method must be implemented.