public interface JournalQuerySession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchJournals()
Tests if this user can perform
Journal searches. |
JournalQuery |
getJournalQuery()
Gets a journal query.
|
JournalList |
getJournalsByQuery(JournalQuery journalQuery)
Gets a list of
Journals matching the given search. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchJournals()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. JournalQuery getJournalQuery()
mandatory
- This method must be implemented. JournalList getJournalsByQuery(JournalQuery journalQuery) throws OperationFailedException, PermissionDeniedException
Journals
matching the given search.journalQuery
- the journal query JournalList
NullArgumentException
- journalQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- journalQuery
is
not of this servicemandatory
- This method must be implemented.