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

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

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.

MethodgetJournalId
Description

Gets the Journal Id associated with this session.

Returnosid.id.Idthe Journal Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetJournal
Description

Gets the Journal associated with this session.

Returnosid.journaling.Journalthe journal
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchJournalEntries
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 wish not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedJournalView
Description

Federates the view for methods in this session. A federated view will include entries in journals which are children of this journal in the journal hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedJournalView
Description

Isolates the view for methods in this session. An isolated view restricts searches to this journal only.

CompliancemandatoryThis method is must be implemented.
MethodgetJournalEntryQuery
Description

Gets a journal entry query.

Returnosid.journaling.JournalEntryQuerythe journal entry query
CompliancemandatoryThis method must be implemented.
MethodgetJournalEntriesByQuery
Description

Gets a list of journal entries matching the given journal entry query.

Parametersosid.journaling.JournalEntryQueryjournalEntryQuerythe journal entry query
Returnosid.journaling.JournalEntryListthe returned JournalEntryList
ErrorsNULL_ARGUMENT journalEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED journalQuery is not of this service
CompliancemandatoryThis method must be implemented.