Interface LogEntrySmartLogSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
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 .

  • Method Details

    • getLogId

      Id getLogId()
      Gets the Log Id associated with this session.
      Returns:
      the Log Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getLog

      Log getLog() throws OperationFailedException, PermissionDeniedException
      Gets the Log associated with this session.
      Returns:
      the Log associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartLog

      boolean canManageSmartLog()
      Tests if this user can manage smart log. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart log management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryQuery

      LogEntryQuery getLogEntryQuery()
      Gets a logEntry query.
      Returns:
      the log entry query
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntrySearchOrder

      LogEntrySearchOrder getLogEntrySearchOrder()
      Gets a logEntry search order.
      Returns:
      the logEntry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyLogEntryQuery

      void applyLogEntryQuery(LogEntryQuery logEntryQuery) throws OperationFailedException, PermissionDeniedException
      Applies a logEntry query to this log.
      Parameters:
      logEntryQuery - the logEntry query
      Throws:
      NullArgumentException - logEntryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - logEntryQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectLogEntryQuery

      LogEntryQueryInspector inspectLogEntryQuery() throws OperationFailedException, PermissionDeniedException
      Gets a logEntry query inspector for this log.
      Returns:
      the logEntry query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyLogEntrySequencing

      void applyLogEntrySequencing(LogEntrySearchOrder logEntrySearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a logEntry search order to this log.
      Parameters:
      logEntrySearchOrder - the logEntry search order
      Throws:
      NullArgumentException - logEntrySearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - logEntrySearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryQueryFromInspector

      LogEntryQuery getLogEntryQueryFromInspector(LogEntryQueryInspector logEntryQueryInspector)
      Gets a logEntry query from an inspector.
      Parameters:
      logEntryQueryInspector - a resorce relationship query inspector
      Returns:
      the logEntry query
      Throws:
      NullArgumentException - logEntryQueryInspector is null
      UnsupportedException - logEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.