OSID Logo
OSID Specifications
logging batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.logging.batch.LogEntryPurgeSession
Implementsosid.OsidSession
Description

This session defines methods to trim and purge logs.

MethodpurgeLogEntries
Description

Deletes all LogEntries in this Log .

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodpurgeLogEntriesByResource
Description

Deletes log entries for the given resource.

Parametersosid.id.IdresourceIdthe Id of a resource
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodpurgeLogEntriesByDate
Description

Deletes log entries between the given date range inclusive.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodpurgeLogEntriesByResourceAndDate
Description

Deletes log entries for the given resource between the given date range inclusive.

Parametersosid.id.IdresourceIdthe Id of a resource
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodpurgeLogEntriesByPriorityTypeAndByDate
Description

Deletes log entries at or below the given priority between the given date range inclusive.

Parametersosid.type.TypepriorityTypea priority type
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT priorityType, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.