org.osid.journaling

Interface JournalEntryQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

JournalEntrySearchSession

public interface JournalEntryQuerySession
extends OsidSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchJournalEntries() Tests if this user can perform Journal searches.
Journal	getJournal() Gets the Journal associated with this session.
JournalEntryList	getJournalEntriesByQuery(JournalEntryQuery journalEntryQuery) Gets a list of journal entries matching the given journal entry query.
JournalEntryQuery	getJournalEntryQuery() Gets a journal entry query.
Id	getJournalId() Gets the Journal Id associated with this session.
void	useFederatedJournalView() Federates the view for methods in this session.
void	useIsolatedJournalView() Isolates the view for methods in this session.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getJournalId

Id getJournalId()

Gets the Journal Id associated with this session.

Returns:

the Journal Id associated with this session

Compliance:

mandatory - This method must be implemented.

getJournal

Journal getJournal()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Journal associated with this session.

Returns:

the journal

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchJournalEntries

boolean canSearchJournalEntries()

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.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedJournalView

void useFederatedJournalView()

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.

Compliance:

mandatory - This method is must be implemented.

useIsolatedJournalView

void useIsolatedJournalView()

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

Compliance:

mandatory - This method is must be implemented.

getJournalEntryQuery

JournalEntryQuery getJournalEntryQuery()

Gets a journal entry query.

Returns:

the journal entry query

Compliance:

mandatory - This method must be implemented.

getJournalEntriesByQuery

JournalEntryList getJournalEntriesByQuery(JournalEntryQuery journalEntryQuery)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

journalEntryQuery - the journal entry query

Returns:

the returned JournalEntryList

Throws:

NullArgumentException - journalEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - journalQuery is not of this service

Compliance:

mandatory - This method must be implemented.