OSID Logo
OSID Specifications
logging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.LoggingProfile
Implementsosid.OsidProfile
Description

The logging profile describes the interoperability among logging services.

MethodsupportsVisibleFederation
Description

Tests if visible federation is supported.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogging
Description

Tests if logging is supported.

Returnboolean true if logging is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryLookup
Description

Tests if reading logs is supported.

Returnboolean true if reading logs is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryQuery
Description

Tests if querying log entries is supported.

Returnboolean true if querying log entries is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntrySearch
Description

Tests if searching log entries is supported.

Returnboolean true if searching log entries is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryNotification
Description

Tests if log entry notification is supported,.

Returnboolean true if log entry notification is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryLog
Description

Tests if looking up log entry log mappings is supported.

Returnboolean true if log entry logs is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryLogAssignment
Description

Tests if managing log entry log mappings is supported.

Returnboolean true if log entry logs mapping assignment is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntrySmartLog
Description

Tests if smart logs is supported.

Returnboolean true if smart logs is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogLookup
Description

Tests for the availability of a log lookup service.

Returnboolean true if log lookup is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogQuery
Description

Tests if querying logs is available.

Returnboolean true if log query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogSearch
Description

Tests if searching for logs is available.

Returnboolean true if log search is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogAdmin
Description

Tests for the availability of a log administrative service for creating and deleting logs.

Returnboolean true if log administration is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogNotification
Description

Tests for the availability of a log notification service.

Returnboolean true if log notification is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsLogHierarchy
Description

Tests for the availability of a log hierarchy traversal service.

Returnboolean true if log hierarchy traversal is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsLogHierarchyDesign
Description

Tests for the availability of a log hierarchy design service.

Returnboolean true if log hierarchy design is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodsupportsLoggingBatch
Description

Tests for the availability of a logging batch service.

Returnboolean true if loggin batch service is available, false otherwise
CompliancemandatoryThis method must be implemented in all providers.
MethodgetLogEntryRecordTypes
Description

Gets the supported Log record types.

Returnosid.type.TypeLista list containing the supported log record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntryRecordType
Description

Tests if the given LogEntry record type is supported.

Parametersosid.type.TypelogEntryRecordTypea Type indicating a LogEntry record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT logEntryRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetLogEntrySearchRecordTypes
Description

Gets the supported log entry search record types.

Returnosid.type.TypeLista list containing the supported log entry search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLogEntrySearchRecordType
Description

Tests if the given log entry search record type is supported.

Parametersosid.type.TypelogEntrySearchRecordTypea Type indicating a log entry record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT logEntrySearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetLogRecordTypes
Description

Gets the supported Log record types.

Returnosid.type.TypeLista list containing the supported log record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLogRecordType
Description

Tests if the given Log record type is supported.

Parametersosid.type.TypelogRecordTypea Type indicating a Log record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT logRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetLogSearchRecordTypes
Description

Gets the supported log search record types.

Returnosid.type.TypeLista list containing the supported log search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsLogSearchRecordType
Description

Tests if the given log search record type is supported.

Parametersosid.type.TypelogSearchRecordTypea Type indicating a log record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT logSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPriorityTypes
Description

Gets the priority types supported, in ascending order of the priority level.

Returnosid.type.TypeLista list containing the supported priority types
CompliancemandatoryThis method must be implemented.
MethodsupportsPriorityType
Description

Tests if the priority type is supported.

Parametersosid.type.TypepriorityTypea Type indicating a priority type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT priorityType is null
CompliancemandatoryThis method must be implemented.
MethodgetContentTypes
Description

Gets the content types supported.

Returnosid.type.TypeLista list containing the supported content types
CompliancemandatoryThis method must be implemented.
MethodsupportsContentType
Description

Tests if the content type is supported.

Parametersosid.type.TypecontentTypea Type indicating a content type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT contentType is null
CompliancemandatoryThis method must be implemented.