OSID - osid.logging.LoggingManager Service Interface Definition

Interface	osid.logging.LoggingManager
Implements	`osid.OsidManager`
Implements	`osid.logging.LoggingProfile`
Description	The logging manager provides access to logging sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `LoggingSession:` a session to write to a log `LogEntryLookupSession:` a session to read a log `LogEntryQuerySession:` a session to search a log `LogEntrySearchSession:` a session to search a log `LogEntryAdminSession:` a session to manage log entries in a log `LogEntryNotificationSession:` a session to subscribe to notifications of new log entries `LogEntryLogSession:` a session to examine log entry to log mappings `LogEntryLogAssignmentSession:` a session to manage log entry to log mappings `LogEntrySmartLogSession:` a session to manage dynamic logs `LogLookupSession:` a session to retrieve log objects `LogQuerySession:` a session to search for logs `LogSearchSession:` a session to search for logs `LogAdminSession:` a session to create, update and delete logs `LogNotificationSession:` a session to receive notifications for changes in logs `LogHierarchyTraversalSession:` a session to traverse hierarchies of logs `LogHierarchyDesignSession:` a session to manage hierarchies of logs The logging manager also provides a profile for determing the supported search types supported by this service.
Method	getLoggingSession
Description	Gets the `OsidSession` associated with the logging service.
Return	`osid.logging.LoggingSession`		a `LoggingSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogging()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogging()` is `true.`
Method	getLoggingSessionForLog
Description	Gets the `OsidSession` associated with the logging service for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LoggingSession`		a `LoggingSession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogging()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogging()` and `supportsVisibleFederation()` are `true`
Method	getLogEntryLookupSession
Description	Gets the `OsidSession` associated with the log reading service.
Return	`osid.logging.LogEntryLookupSession`		a `LogEntryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryLookup()` is `true.`
Method	getLogEntryLookupSessionForLog
Description	Gets the `OsidSession` associated with the log reading service for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LogEntryLookupSession`		a `LogEntryLookupSession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryLookup()` and `supportsVisibleFederation()` are `true`
Method	getLogEntryQuerySession
Description	Gets the `OsidSession` associated with the logging entry query service.
Return	`osid.logging.LogEntryQuerySession`		a `LogEntryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryQuery()` is `true.`
Method	getLogEntryQuerySessionForLog
Description	Gets the `OsidSession` associated with the log entry query service for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LogEntryQuerySession`		a `LogEntryQuerySession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryQuery()` and `supportsVisibleFederation()` are `true`
Method	getLogEntrySearchSession
Description	Gets the `OsidSession` associated with the logging entry search service.
Return	`osid.logging.LogEntrySearchSession`		a `LogEntrySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntrySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntrySearch()` is `true.`
Method	getLogEntrySearchSessionForLog
Description	Gets the `OsidSession` associated with the log entry search service for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LogEntrySearchSession`		a `LogEntrySearchSession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntrySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntrySearch()` and `supportsVisibleFederation()` are `true`
Method	getLogEntryAdminSession
Description	Gets the `OsidSession` associated with the logging entry administrative service.
Return	`osid.logging.LogEntryAdminSession`		a `LogEntryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryAdmin()` is `true.`
Method	getLogEntryAdminSessionForLog
Description	Gets the `OsidSession` associated with the log entry administrative service for the given log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LogEntryAdminSession`		a `LogEntryAdminSession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntryAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryAdmin()` and `supportsVisibleFederation()` are `true`
Method	getLogEntryNotificationSession
Description	Gets the `OsidSession` associated with the logging entry notification service.
Parameters	`osid.logging.LogEntryReceiver`	`logEntryReceiver`	the receiver
Return	`osid.logging.LogEntryNotificationSession`		a `LogEntryNotificationSession`
Errors	NULL_ARGUMENT		`logEntryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryNotification()` is `true.`
Method	getLogEntryNotificationSessionForLog
Description	Gets the `OsidSession` associated with the log entry notification service for the given log.
Parameters	`osid.logging.LogEntryReceiver`	`logEntryReceiver`	the receiver
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log`
Return	`osid.logging.LogEntryNotificationSession`		a `LogEntryNotificationSession`
Errors	NOT_FOUND		no `Log` found by the given `Id`
	NULL_ARGUMENT		`logEntryReceiver` or `logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryNotification()` and `supportsVisibleFederation()` are `true`
Method	getLogEntryLogSession
Description	Gets the session for retrieving log entry to log mappings.
Return	`osid.logging.LogEntryLogSession`		a `LogEntryLogSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntryLog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryLog()` is `true.`
Method	getLogEntryLogAssignmentSession
Description	Gets the session for assigning log entry to logs mappings.
Return	`osid.logging.LogEntryLogAssignmentSession`		a `LogEntryLogAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogEntryLogAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntryLogAssignment()` is `true.`
Method	getLogEntrySmartLogSession
Description	Gets the session for managing dynamic logEntry log.
Parameters	`osid.id.Id`	`logId`	the `Id` of the log
Return	`osid.logging.LogEntrySmartLogSession`		a `LogEntrySmartLogSession`
Errors	NOT_FOUND		`logId` not found
	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogEntrySmartLog()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogEntrySmartLog()` is `true.`
Method	getLogLookupSession
Description	Gets the `OsidSession` associated with the log lookup service.
Return	`osid.logging.LogLookupSession`		a `LogLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogLookup()` is `true.`
Method	getLogQuerySession
Description	Gets the `OsidSession` associated with the log query service.
Return	`osid.logging.LogQuerySession`		a `LogQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogQuery()` is `true.`
Method	getLogSearchSession
Description	Gets the `OsidSession` associated with the log search service.
Return	`osid.logging.LogSearchSession`		a `LogSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogSearch()` is `true.`
Method	getLogAdminSession
Description	Gets the `OsidSession` associated with the log administrative service.
Return	`osid.logging.LogAdminSession`		a `LogAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogAdmin()` is `true.`
Method	getLogNotificationSession
Description	Gets the `OsidSession` associated with the log notification service.
Parameters	`osid.logging.LogReceiver`	`logReceiver`	the receiver
Return	`osid.logging.LogNotificationSession`		a `LogNotificationSession`
Errors	NULL_ARGUMENT		`logReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLogNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogNotification()` is `true.`
Method	getLogHierarchySession
Description	Gets the `OsidSession` associated with the log hierarchy service.
Return	`osid.logging.LogHierarchySession`		a `LogHierarchySession` for logs
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogHierarchy()` is `true.`
Method	getLogHierarchyDesignSession
Description	Gets the `OsidSession` associated with the log hierarchy design service.
Return	`osid.logging.LogHierarchyDesignSession`		a `HierarchyDesignSession` for logs
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLogHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLogHierarchyDesign()` is `true.`
Method	getLoggingBatchManager
Description	Gets a `LoggingBatchManager.`
Return	`osid.logging.batch.LoggingBatchManager`		a `LoggingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLoggingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLoggingBatch()` is `true.`