| Interface | osid.logging.batch.LoggingBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.logging.batch.LoggingBatchProfile | |||
| Description |
The logging batch manager provides access to logging batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getLogEntryBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.logging.batch.LogEntryBatchAdminSession | a LogEntryBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsLogEntryBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsLogEntryBatchAdmin()
is true. | |
| Method | getLogEntryBatchAdminSessionForLog | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | logId | the Id of the Log |
| Return | osid.logging.batch.LogEntryBatchAdminSession | a LogEntryBatchAdminSession | |
| Errors | NOT_FOUND | no Log found by the given Id | |
| NULL_ARGUMENT | logId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsLogEntryBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsLogEntryBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getLogEntryPurgeSession | ||
| Description |
Gets the | ||
| Return | osid.logging.batch.LogEntryPurgeSession | a LogEntryPurgeSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsLogEntryPurge() is false | ||
| Compliance | optional | This method must be implemented if supportsLogEntryPurge()
is true. | |
| Method | getLogEntryPurgeSessionForLog | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | logId | the Id of the Log |
| Return | osid.logging.batch.LogEntryPurgeSession | a LogEntryPurgeSession | |
| Errors | NOT_FOUND | no Log found by the given Id | |
| NULL_ARGUMENT | logId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsLogEntryPurge() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsLogEntryPurge()
and supportsVisibleFederation() are true | |
| Method | getLogBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.logging.batch.LogBatchAdminSession | a LogBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsLogBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsLogBatchAdmin()
is true. | |