org.osid.logging.batch

Interface LogEntryPurgeSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface LogEntryPurgeSession
extends OsidSession

This session defines methods to trim and purge logs.

Method Summary

Methods

Modifier and Type	Method and Description
void	purgeLogEntries() Deletes all LogEntries in this Log .
void	purgeLogEntriesByDate(DateTime from, DateTime to) Deletes log entries between the given date range inclusive.
void	purgeLogEntriesByPriorityTypeAndByDate(Type priorityType, DateTime from, DateTime to) Deletes log entries at or below the given priority between the given date range inclusive.
void	purgeLogEntriesByResource(Id resourceId) Deletes log entries for the given resource.
void	purgeLogEntriesByResourceAndDate(Id resourceId, DateTime from, DateTime to) Deletes log entries for the given resource between the given date range inclusive.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

purgeLogEntries

void purgeLogEntries()
                     throws OperationFailedException,
                            PermissionDeniedException

Deletes all LogEntries in this Log .

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

purgeLogEntriesByResource

void purgeLogEntriesByResource(Id resourceId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes log entries for the given resource.

Parameters:

resourceId - the Id of a resource

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

purgeLogEntriesByDate

void purgeLogEntriesByDate(DateTime from,
                         DateTime to)
                           throws OperationFailedException,
                                  PermissionDeniedException

Deletes log entries between the given date range inclusive.

Parameters:

from - starting date

to - ending date

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

purgeLogEntriesByResourceAndDate

void purgeLogEntriesByResourceAndDate(Id resourceId,
                                    DateTime from,
                                    DateTime to)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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

Parameters:

resourceId - the Id of a resource

from - starting date

to - ending date

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

purgeLogEntriesByPriorityTypeAndByDate

void purgeLogEntriesByPriorityTypeAndByDate(Type priorityType,
                                          DateTime from,
                                          DateTime to)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

priorityType - a priority type

from - starting date

to - ending date

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - priorityType, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.