Interface LogEntryPurgeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LogEntryPurgeSession
extends OsidSession

This session defines methods to trim and purge logs.

Method Summary

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.