org.cyclos.impl.system

Interface EntityLogHandler<E extends BaseEntity,DTO extends EntityDTO>

public interface EntityLogHandler<E extends BaseEntity,DTO extends EntityDTO>

To enable the log for an entity an implementation of this interface must be created.

Author:

acastro

See Also:

BaseEntityLogHandlerImpl, EntityLogRegistry

Method Summary

Modifier and Type	Method and Description
void	applyLogFilters(org.cyclos.impl.utils.persistence.DBQuery<?> query, EntityPropertyLogQuery params) Apply filters to the given query to ensure only the entity log the logged user can view are returned
boolean	areEquals(E oldEntity, E newEntity, org.cyclos.impl.utils.validation.PropertyAccess access, java.lang.Object oldValue, java.lang.Object newValue) Returns true if the old and new values extracted from its corresponding entities must be considered equals.
boolean	canViewEntityLog(long entityId) Returns whether the logged user can view the log of the given entity.
java.lang.Class<E>	getEntityClass() The entity class related to this handler
java.lang.String	getEntityLogName(E oldEntity, E newEntity, EntityLogEvent event) Return the name of the entity log being generated.
EntityLogType	getType() The log type this handler manages.
Pair<java.lang.Object,java.lang.Object>	getValues(E oldEntity, E newEntity, org.cyclos.impl.PropertyLogDescriptor<DTO> propertyDescriptor) Allows custom logic for a specific property to be logged bypassing the default log generation for it.
boolean	isLogEnabled(E entity) Returns true if the log is enabled for this specific entity instance.
java.util.List<EntityPropertyLog>	onBeforeLog(E oldEntity, E newEntity, java.util.List<EntityPropertyLog> propertyLogs, EntityLogEvent event) Allows perform custom logic before logging (i.e saving) the given property logs.
org.cyclos.impl.EntityLogDescriptor<? extends DTO>	resolveLogDescriptor(E entity) Return the descriptor with the mappings for each DTO property.

Method Detail

applyLogFilters

void applyLogFilters(org.cyclos.impl.utils.persistence.DBQuery<?> query,
                     EntityPropertyLogQuery params)

Apply filters to the given query to ensure only the entity log the logged user can view are returned

areEquals

boolean areEquals(E oldEntity,
                  E newEntity,
                  org.cyclos.impl.utils.validation.PropertyAccess access,
                  java.lang.Object oldValue,
                  java.lang.Object newValue)

Returns true if the old and new values extracted from its corresponding entities must be considered equals.

canViewEntityLog

boolean canViewEntityLog(long entityId)

Returns whether the logged user can view the log of the given entity.

getEntityClass

java.lang.Class<E> getEntityClass()

The entity class related to this handler

getEntityLogName

java.lang.String getEntityLogName(E oldEntity,
                                  E newEntity,
                                  EntityLogEvent event)

Return the name of the entity log being generated.

getType

EntityLogType getType()

The log type this handler manages.

getValues

Pair<java.lang.Object,java.lang.Object> getValues(E oldEntity,
                                                  E newEntity,
                                                  org.cyclos.impl.PropertyLogDescriptor<DTO> propertyDescriptor)

Allows custom logic for a specific property to be logged bypassing the default log generation for it.

Returns:

null for the default generation (i.e no custom logic implemented) or a pair of the form to be saved as-is only if areEquals(BaseEntity, BaseEntity, PropertyAccess, Object, Object) return false.

isLogEnabled

boolean isLogEnabled(E entity)

Returns true if the log is enabled for this specific entity instance.

onBeforeLog

java.util.List<EntityPropertyLog> onBeforeLog(E oldEntity,
                                              E newEntity,
                                              java.util.List<EntityPropertyLog> propertyLogs,
                                              EntityLogEvent event)

Allows perform custom logic before logging (i.e saving) the given property logs. The returned list will be final logs to be saved (subclasses can add / remove logs). In case of EntityLogEvent.CREATE event the result list will contain only one element, this is for that case we only log one line just to indicate when and who created the entity.

resolveLogDescriptor

org.cyclos.impl.EntityLogDescriptor<? extends DTO> resolveLogDescriptor(E entity)

Return the descriptor with the mappings for each DTO property.