Interface LogEntryQuerySession

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

  • federated log view: searches include entries in logs of which this log is an ancestor in the log hierarchy
  • isolated log view: searches are restricted to entries in this log only

  • 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.

    • canSearchLogEntries

      boolean canSearchLogEntries()
      Tests if this user can perform 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.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedLogView

      void useFederatedLogView()
      Federates the view for methods in this session. A federated view will include entries in logs which are children of this log in the log hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedLogView

      void useIsolatedLogView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this log only.
      Compliance:
      mandatory - This method is must be implemented.

    • getLogEntryQuery

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

    • getLogEntriesByQuery

      LogEntryList getLogEntriesByQuery(LogEntryQuery logEntryQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of log entries matching the given log entry query
      Parameters:
      logEntryQuery - the log entry query
      Returns:
      the returned LogEntryList
      Throws:
      NullArgumentException - logEntryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - logEntryQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.