public interface LogQuerySession extends OsidSession
This session provides methods for searching Log
objects.
The search query is constructed using the LogQuery.
The log
record Type
also specifies the record for the log query.
Logs may have a query record indicated by their respective record
types. The query record is accessed via the LogQuery.
The
returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchLogs()
Tests if this user can perform
Log searches. |
LogQuery |
getLogQuery()
Gets a log query.
|
LogList |
getLogsByQuery(LogQuery logQuery)
Gets a list of
Logs matching the given log query. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchLogs()
Log
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. LogQuery getLogQuery()
mandatory
- This method must be implemented. LogList getLogsByQuery(LogQuery logQuery) throws OperationFailedException, PermissionDeniedException
Logs
matching the given log query.logQuery
- the log query LogList
NullArgumentException
- logQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- logQuery
is not
of this servicemandatory
- This method must be implemented.