Package com.io7m.idstore.database.api

# Interface IdDatabaseAuditQueriesType

All Superinterfaces:
  `IdDatabaseQueriesType`

public non-sealed interface IdDatabaseAuditQueriesType extends IdDatabaseQueriesType
The database queries involving the audit log.

- ## Field Summary

  ### Fields inherited from interface com.io7m.idstore.database.api.IdDatabaseQueriesType

  `EARLIEST`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `long`
  `auditCount(IdAuditSearchParameters parameters)`
  `List<IdAuditEvent>`
  `auditEvents(IdAuditSearchParameters parameters, OptionalLong seek)`
  Retrieve all audit events from the database matching the given parameters.
  `void`
  `auditPut(UUID userId, OffsetDateTime time, String type, String message)`
  Create an audit event.

- ## Method Details

  - ### auditEvents

    List<IdAuditEvent> auditEvents(IdAuditSearchParameters parameters, OptionalLong seek) throws IdDatabaseException
    Retrieve all audit events from the database matching the given parameters.
    Parameters:
      `parameters` - The search parameters
      `seek` - The record to which to seek, if any
    Returns:
      A series of audit events, sorted by time
    Throws:
      `IdDatabaseException` - On errors

  - ### auditPut

    void auditPut(UUID userId, OffsetDateTime time, String type, String message) throws IdDatabaseException
    Create an audit event.
    Parameters:
      `userId` - The user ID of the event
      `time` - The event time
      `type` - The event type
      `message` - The event message
    Throws:
      `IdDatabaseException` - On errors

  - ### auditCount

    long auditCount(IdAuditSearchParameters parameters) throws IdDatabaseException
    Parameters:
      `parameters` - The parameters
    Returns:
      The number of events matching the given parameter
    Throws:
      `IdDatabaseException`