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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getJournalId()
Journal
Id
associated with this
session. Journal Id
associated with this sessionmandatory
- This method must be implemented. Journal getJournal() throws OperationFailedException, PermissionDeniedException
Journal
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchJournalEntries()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedJournalView()
mandatory
- This method is must be implemented. void useIsolatedJournalView()
mandatory
- This method is must be implemented. JournalEntryQuery getJournalEntryQuery()
mandatory
- This method must be implemented. JournalEntryList getJournalEntriesByQuery(JournalEntryQuery journalEntryQuery) throws OperationFailedException, PermissionDeniedException
journalEntryQuery
- the journal entry query JournalEntryList
NullArgumentException
- journalEntryQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- journalQuery
is
not of this servicemandatory
- This method must be implemented.