public interface LogEntryQuerySession extends OsidSession
This session provides methods for searching among log entries. The
search query is constructed using the LogEntryQuery.
This session defines views that offer differing behaviors for searching.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchLogEntries()
Tests if this user can perform
LogEntry searches. |
Log |
getLog()
Gets the
Log associated with this session. |
LogEntryList |
getLogEntriesByQuery(LogEntryQuery logEntryQuery)
Gets a list of log entries matching the given log entry query
|
LogEntryQuery |
getLogEntryQuery()
Gets a log entry query
|
Id |
getLogId()
Gets the
Log Id associated with this
session. |
void |
useFederatedLogView()
Federates the view for methods in this session.
|
void |
useIsolatedLogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getLogId()
Log
Id
associated with this
session. Log Id
associated with this sessionmandatory
- This method must be implemented. Log getLog() throws OperationFailedException, PermissionDeniedException
Log
associated with this session. Log
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchLogEntries()
LogEntry
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. void useFederatedLogView()
mandatory
- This method is must be implemented. void useIsolatedLogView()
mandatory
- This method is must be implemented. LogEntryQuery getLogEntryQuery()
mandatory
- This method must be implemented. LogEntryList getLogEntriesByQuery(LogEntryQuery logEntryQuery) throws OperationFailedException, PermissionDeniedException
logEntryQuery
- the log entry query LogEntryList
NullArgumentException
- logEntryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- logEntryQuery
is
not of this servicemandatory
- This method must be implemented.