Interface | osid.logging.LoggingProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The logging profile describes the interoperability among logging services. | ||
Method | supportsVisibleFederation | ||
Description |
Tests if visible federation is supported. | ||
Return | boolean | true if visible federation is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogging | ||
Description |
Tests if logging is supported. | ||
Return | boolean | true if logging is supported, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryLookup | ||
Description |
Tests if reading logs is supported. | ||
Return | boolean | true if reading logs is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryQuery | ||
Description |
Tests if querying log entries is supported. | ||
Return | boolean | true if querying log entries is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntrySearch | ||
Description |
Tests if searching log entries is supported. | ||
Return | boolean | true if searching log entries is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryNotification | ||
Description |
Tests if log entry notification is supported,. | ||
Return | boolean | true if log entry notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryLog | ||
Description |
Tests if looking up log entry log mappings is supported. | ||
Return | boolean | true if log entry logs is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryLogAssignment | ||
Description |
Tests if managing log entry log mappings is supported. | ||
Return | boolean | true if log entry logs mapping assignment is supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntrySmartLog | ||
Description |
Tests if smart logs is supported. | ||
Return | boolean | true if smart logs is supported, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogLookup | ||
Description |
Tests for the availability of a log lookup service. | ||
Return | boolean | true if log lookup is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogQuery | ||
Description |
Tests if querying logs is available. | ||
Return | boolean | true if log query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogSearch | ||
Description |
Tests if searching for logs is available. | ||
Return | boolean | true if log search is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogAdmin | ||
Description |
Tests for the availability of a log administrative service for creating and deleting logs. | ||
Return | boolean | true if log administration is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogNotification | ||
Description |
Tests for the availability of a log notification service. | ||
Return | boolean | true if log notification is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsLogHierarchy | ||
Description |
Tests for the availability of a log hierarchy traversal service. | ||
Return | boolean | true if log hierarchy traversal is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogHierarchyDesign | ||
Description |
Tests for the availability of a log hierarchy design service. | ||
Return | boolean | true if log hierarchy design is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | supportsLoggingBatch | ||
Description |
Tests for the availability of a logging batch service. | ||
Return | boolean | true if loggin batch service is available, false
otherwise | |
Compliance | mandatory | This method must be implemented in all providers. | |
Method | getLogEntryRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported log record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntryRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | logEntryRecordType | a Type indicating a LogEntry record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | logEntryRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogEntrySearchRecordTypes | ||
Description |
Gets the supported log entry search record types. | ||
Return | osid.type.TypeList | a list containing the supported log entry search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogEntrySearchRecordType | ||
Description |
Tests if the given log entry search record type is supported. | ||
Parameters | osid.type.Type | logEntrySearchRecordType | a Type indicating a log entry record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | logEntrySearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogRecordTypes | ||
Description |
Gets the supported | ||
Return | osid.type.TypeList | a list containing the supported log record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogRecordType | ||
Description |
Tests if the given | ||
Parameters | osid.type.Type | logRecordType | a Type indicating a Log record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | logRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getLogSearchRecordTypes | ||
Description |
Gets the supported log search record types. | ||
Return | osid.type.TypeList | a list containing the supported log search record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLogSearchRecordType | ||
Description |
Tests if the given log search record type is supported. | ||
Parameters | osid.type.Type | logSearchRecordType | a Type indicating a log record type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | logSearchRecordType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriorityTypes | ||
Description |
Gets the priority types supported, in ascending order of the priority level. | ||
Return | osid.type.TypeList | a list containing the supported priority types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsPriorityType | ||
Description |
Tests if the priority type is supported. | ||
Parameters | osid.type.Type | priorityType | a Type indicating a priority type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | priorityType is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getContentTypes | ||
Description |
Gets the content types supported. | ||
Return | osid.type.TypeList | a list containing the supported content types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsContentType | ||
Description |
Tests if the content type is supported. | ||
Parameters | osid.type.Type | contentType | a Type indicating a content type |
Return | boolean | true if the given Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | contentType is null | |
Compliance | mandatory | This method must be implemented. |