Package de.xima.fc.certificate.ms.impl.audit

Interface IAuditAction<TEntity extends IAuditableEntity>

Type Parameters:

TEntity - the type of entity being audited, which must implement IAuditableEntity

All Known Implementing Classes:

CertificateAuditAction

public interface IAuditAction<TEntity extends IAuditableEntity>

Interface representing an audit action in the system.

Since:

8.5.0

Author:

Norman Lorenz

Method Summary

Modifier and Type	Method	Description
String	getAuditDetails(TEntity entity, Locale locale, AuditParameter... params)	Returns the localized details for an audit entry for this action.
String	getAuditMessage(TEntity entity, Locale locale, AuditParameter... params)	Returns the localized message for an audit entry for this action.
ECrudAction	getCrudActionType()	Returns the basic CRUD action type associated with this audit action.

Method Detail

getCrudActionType

ECrudAction getCrudActionType()

Returns the basic CRUD action type associated with this audit action.

Returns:

the CRUD action type

getAuditDetails

String getAuditDetails(TEntity entity,
                       Locale locale,
                       AuditParameter... params)

Returns the localized details for an audit entry for this action.

Parameters:

entity - the entity being audited

locale - the locale for localization

params - optional parameters for additional context

Returns:

the localized details

getAuditMessage

String getAuditMessage(TEntity entity,
                       Locale locale,
                       AuditParameter... params)

Returns the localized message for an audit entry for this action.

Parameters:

entity - the entity being audited

locale - the locale for localization

params - optional parameters for additional context

Returns:

the localized message