Interface LoggingProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
LoggingManager, LoggingProxyManager
public interface LoggingProfile extends OsidProfile

The logging profile describes the interoperability among logging services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if visible federation is supported.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogging

      boolean supportsLogging()
      Tests if logging is supported.
      Returns:
      true if logging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryLookup

      boolean supportsLogEntryLookup()
      Tests if reading logs is supported.
      Returns:
      true if reading logs is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryQuery

      boolean supportsLogEntryQuery()
      Tests if querying log entries is supported.
      Returns:
      true if querying log entries is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntrySearch

      boolean supportsLogEntrySearch()
      Tests if searching log entries is supported.
      Returns:
      true if searching log entries is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryAdmin

      boolean supportsLogEntryAdmin()
      Tests if managing log entries is supported.
      Returns:
      true if managing log entries is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryNotification

      boolean supportsLogEntryNotification()
      Tests if log entry notification is supported,.
      Returns:
      true if log entry notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryLog

      boolean supportsLogEntryLog()
      Tests if looking up log entry log mappings is supported.
      Returns:
      true if log entry logs is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryLogAssignment

      boolean supportsLogEntryLogAssignment()
      Tests if managing log entry log mappings is supported.
      Returns:
      true if log entry logs mapping assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntrySmartLog

      boolean supportsLogEntrySmartLog()
      Tests if smart logs is supported.
      Returns:
      true if smart logs is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogLookup

      boolean supportsLogLookup()
      Tests for the availability of a log lookup service.
      Returns:
      true if log lookup is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogQuery

      boolean supportsLogQuery()
      Tests if querying logs is available.
      Returns:
      true if log query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogSearch

      boolean supportsLogSearch()
      Tests if searching for logs is available.
      Returns:
      true if log search is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogAdmin

      boolean supportsLogAdmin()
      Tests for the availability of a log administrative service for creating and deleting logs.
      Returns:
      true if log administration is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogNotification

      boolean supportsLogNotification()
      Tests for the availability of a log notification service.
      Returns:
      true if log notification is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsLogHierarchy

      boolean supportsLogHierarchy()
      Tests for the availability of a log hierarchy traversal service.
      Returns:
      true if log hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogHierarchyDesign

      boolean supportsLogHierarchyDesign()
      Tests for the availability of a log hierarchy design service.
      Returns:
      true if log hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsLoggingBatch

      boolean supportsLoggingBatch()
      Tests for the availability of a logging batch service.
      Returns:
      true if loggin batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • getLogEntryRecordTypes

      TypeList getLogEntryRecordTypes()
      Gets the supported Log record types.
      Returns:
      a list containing the supported log record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntryRecordType

      boolean supportsLogEntryRecordType(Type logEntryRecordType)
      Tests if the given LogEntry record type is supported.
      Parameters:
      logEntryRecordType - a Type indicating a LogEntry record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - logEntryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntrySearchRecordTypes

      TypeList getLogEntrySearchRecordTypes()
      Gets the supported log entry search record types.
      Returns:
      a list containing the supported log entry search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogEntrySearchRecordType

      boolean supportsLogEntrySearchRecordType(Type logEntrySearchRecordType)
      Tests if the given log entry search record type is supported.
      Parameters:
      logEntrySearchRecordType - a Type indicating a log entry record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - logEntrySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getLogRecordTypes

      TypeList getLogRecordTypes()
      Gets the supported Log record types.
      Returns:
      a list containing the supported log record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogRecordType

      boolean supportsLogRecordType(Type logRecordType)
      Tests if the given Log record type is supported.
      Parameters:
      logRecordType - a Type indicating a Log record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - logRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getLogSearchRecordTypes

      TypeList getLogSearchRecordTypes()
      Gets the supported log search record types.
      Returns:
      a list containing the supported log search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsLogSearchRecordType

      boolean supportsLogSearchRecordType(Type logSearchRecordType)
      Tests if the given log search record type is supported.
      Parameters:
      logSearchRecordType - a Type indicating a log record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - logSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPriorityTypes

      TypeList getPriorityTypes()
      Gets the priority types supported, in ascending order of the priority level.
      Returns:
      a list containing the supported priority types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPriorityType

      boolean supportsPriorityType(Type priorityType)
      Tests if the priority type is supported.
      Parameters:
      priorityType - a Type indicating a priority type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - priorityType is null
      Compliance:
      mandatory - This method must be implemented.

    • getContentTypes

      TypeList getContentTypes()
      Gets the content types supported.
      Returns:
      a list containing the supported content types
      Compliance:
      mandatory - This method must be implemented.

    • supportsContentType

      boolean supportsContentType(Type contentType)
      Tests if the content type is supported.
      Parameters:
      contentType - a Type indicating a content type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - contentType is null
      Compliance:
      mandatory - This method must be implemented.