public interface LogEntrySmartLogSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A LogEntryQuery
can be retrieved from this
session and mapped to this Log
to create a virtual
collection of log entries. The log entries may be sequenced using the
LogEntrySearchOrder
from this session.
This Log
has a default query that matches any log entry
and a default search order that specifies no sequencing. The queries may
be examined using a LogEntryQueryInspector.
The query may
be modified by converting the inspector back to a LogEntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyLogEntryQuery(LogEntryQuery logEntryQuery)
Applies a logEntry query to this log.
|
void |
applyLogEntrySequencing(LogEntrySearchOrder logEntrySearchOrder)
Applies a logEntry search order to this log.
|
boolean |
canManageSmartLog()
Tests if this user can manage smart log.
|
Log |
getLog()
Gets the
Log associated with this session. |
LogEntryQuery |
getLogEntryQuery()
Gets a logEntry query.
|
LogEntryQuery |
getLogEntryQueryFromInspector(LogEntryQueryInspector logEntryQueryInspector)
Gets a logEntry query from an inspector.
|
LogEntrySearchOrder |
getLogEntrySearchOrder()
Gets a logEntry search order.
|
Id |
getLogId()
Gets the
Log Id associated with this
session. |
LogEntryQueryInspector |
inspectLogEntryQuery()
Gets a logEntry query inspector for this log.
|
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 canManageSmartLog()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart log management is not
authorized, true
otherwisemandatory
- This method must be implemented. LogEntryQuery getLogEntryQuery()
mandatory
- This method must be implemented. LogEntrySearchOrder getLogEntrySearchOrder()
mandatory
- This method must be implemented. void applyLogEntryQuery(LogEntryQuery logEntryQuery) throws OperationFailedException, PermissionDeniedException
logEntryQuery
- the logEntry queryNullArgumentException
- logEntryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- logEntryQuery
not
of this servicemandatory
- This method must be implemented. LogEntryQueryInspector inspectLogEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyLogEntrySequencing(LogEntrySearchOrder logEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
logEntrySearchOrder
- the logEntry search orderNullArgumentException
- logEntrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- logEntrySearchOrder
not of this servicemandatory
- This method must be implemented. LogEntryQuery getLogEntryQueryFromInspector(LogEntryQueryInspector logEntryQueryInspector)
logEntryQueryInspector
- a resorce relationship query inspectorNullArgumentException
- logEntryQueryInspector
is null
UnsupportedException
- logEntryQueryInspector
is not of this servicemandatory
- This method must be implemented.