Interface LogEntryAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
LogEntryBatchAdminSession
public interface LogEntryAdminSession extends OsidSession

This session creates, updates, and deletes LogEntries . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a LogEntry , a LogEntryForm is requested using getLogEntryFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned LogEntryForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the LogEntryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each LogEntryForm corresponds to an attempted transaction.

For updates, LogEntryForms are requested to the LogEntry Id that is to be updated using getLogEntryFormForUpdate() . Similarly, the LogEntryForm has metadata about the data that can be updated and it can perform validation before submitting the update. The LogEntryForm can only be used once for a successful update and cannot be reused.

The delete operations delete LogEntries . To unmap a LogEntry from the current Log , the LogEntryLogAssignmentSession should be used. These delete operations attempt to remove the LogEntry itself thus removing it from all known Log catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

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

    • canCreateLogEntries

      boolean canCreateLogEntries()
      Tests if this user can create log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a LogEntry will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
      Returns:
      false if LogEntry creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateLogEntryWithRecordTypes

      boolean canCreateLogEntryWithRecordTypes(Type[] logEntryRecordTypes)
      Tests if this user can create a single LogEntry using the desired record types. While LoggingManager.getLogEntryRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific LogEntry . Providing an empty array tests if a LogEntry can be created with no records.
      Parameters:
      logEntryRecordTypes - array of log entry record types
      Returns:
      true if LogEntry creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - logEntryRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryFormForCreate

      LogEntryForm getLogEntryFormForCreate(Type[] logEntryRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the log entry form for creating new log entries. A new form should be requested for each create transaction.
      Parameters:
      logEntryRecordTypes - array of log entry record types
      Returns:
      the log entry form
      Throws:
      NullArgumentException - logEntryRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createLogEntry

      LogEntry createLogEntry(LogEntryForm logEntryForm) throws OperationFailedException, PermissionDeniedException
      Creates a new LogEntry .
      Parameters:
      logEntryForm - the form for this LogEntry
      Returns:
      the new LogEntry
      Throws:
      IllegalStateException - logEntryForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - logEntryForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - logEntryForm did not originate from getLogEntryFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateLogEntries

      boolean canUpdateLogEntries()
      Tests if this user can update log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Log will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
      Returns:
      false if LogEntry modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntryFormForUpdate

      LogEntryForm getLogEntryFormForUpdate(Id logEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the log entry form for updating an existing log. A new log entry form should be requested for each update transaction.
      Parameters:
      logEntryId - the Id of the LogEntry
      Returns:
      the log entry form
      Throws:
      NotFoundException - logEntryId is not found
      NullArgumentException - logEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateLogEntry

      void updateLogEntry(LogEntryForm logEntryForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing log entry.
      Parameters:
      logEntryForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - logEntryForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - logEntryForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - logEntryForm did not originate from getLogEntryFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteLogEntries

      boolean canDeleteLogEntries()
      Tests if this user can delete log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a LogEntry will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
      Returns:
      false if LogEntry deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteLogEntry

      void deleteLogEntry(Id logEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a LogEntry .
      Parameters:
      logEntryId - the Id of the logEntryId to remove
      Throws:
      NotFoundException - logEntryId not found
      NullArgumentException - logEntryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageLogEntryAliases

      boolean canManageLogEntryAliases()
      Tests if this user can manage Id aliases for log entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if LogEntry aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasLogEntry

      void aliasLogEntry(Id logEntryId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a LogEntry for the purpose of creating compatibility. The primary Id of the LogEntry is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another log entry, it is reassigned to the given log entry Id .
      Parameters:
      logEntryId - the Id of a LogEntry
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - logEntryId not found
      NullArgumentException - logEntryId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.