OSID Specifications
logging batch package
Version 3.0.0
Release Candidate Preview
logging batch package
Version 3.0.0
Release Candidate Preview
| Interface | osid.logging.batch.LogEntryPurgeSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to trim and purge logs. | ||
| Method | purgeLogEntries | ||
| Description |
Deletes all | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | purgeLogEntriesByResource | ||
| Description |
Deletes log entries for the given resource. | ||
| Parameters | osid.id.Id | resourceId | the Id of a resource |
| Errors | NULL_ARGUMENT | resourceId is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | purgeLogEntriesByDate | ||
| Description |
Deletes log entries between the given date range inclusive. | ||
| Parameters | osid.calendaring.DateTime | from | starting date |
osid.calendaring.DateTime | to | ending date | |
| Errors | INVALID_ARGUMENT | from is greater than to | |
| NULL_ARGUMENT | from or to is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | purgeLogEntriesByResourceAndDate | ||
| Description |
Deletes log entries for the given resource between the given date range inclusive. | ||
| Parameters | osid.id.Id | resourceId | the Id of a resource |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
| Errors | INVALID_ARGUMENT | from is greater than to | |
| NULL_ARGUMENT | resourceId, from or to is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | purgeLogEntriesByPriorityTypeAndByDate | ||
| Description |
Deletes log entries at or below the given priority between the given date range inclusive. | ||
| Parameters | osid.type.Type | priorityType | a priority type |
osid.calendaring.DateTime | from | starting date | |
osid.calendaring.DateTime | to | ending date | |
| Errors | INVALID_ARGUMENT | from is greater than to | |
| NULL_ARGUMENT | priorityType, from or to is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |