public interface LogEntryPurgeSession extends OsidSession
This session defines methods to trim and purge logs.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void purgeLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntries
in this Log
.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void purgeLogEntriesByResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourceNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void purgeLogEntriesByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- starting dateto
- ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void purgeLogEntriesByResourceAndDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- the Id
of a resourcefrom
- starting dateto
- ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void purgeLogEntriesByPriorityTypeAndByDate(Type priorityType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
priorityType
- a priority typefrom
- starting dateto
- ending dateInvalidArgumentException
- from
is
greater than to
NullArgumentException
- priorityType, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.