org.cyclos.impl.system

Interface EntityLogServiceLocal

All Superinterfaces:

EntityLogService, Service

public interface EntityLogServiceLocal
extends EntityLogService

Method Summary

Modifier and Type	Method and Description
<E extends BaseEntity> java.util.List<EntityPropertyLog>	createPropertyLogs(E oldEntity, E newEntity, org.cyclos.impl.EntityLogManager handler) For each DTO's property it reads the old value (from oldEntity) and the new one (from newEntity) and compares if they are different.
<E extends BaseEntity> EntityLogEvent	getEntityLogEvent(E oldEntity, E newEntity) Calculates the EntityLogEvent according to the old and new entities.
void	log(java.lang.String entityName, long entityId, java.lang.Long ownerEntityId, EntityLogType type, EntityLogEvent event, java.util.List<EntityPropertyLog> propertyLogs) Creates and persists a new EntityLog with the provided parameters.

Methods inherited from interface org.cyclos.services.system.EntityLogService

load, search

Method Detail

createPropertyLogs

<E extends BaseEntity> java.util.List<EntityPropertyLog> createPropertyLogs(E oldEntity,
                                                                            E newEntity,
                                                                            org.cyclos.impl.EntityLogManager handler)

For each DTO's property it reads the old value (from oldEntity) and the new one (from newEntity) and compares if they are different. if it's the case then it generates a new EntityPropertyLog to be added to the result. At least oldEntity or newEntity must be not null.
The EntityLogEvent is calculated according to the following rules in the following order:

• both oldEntity and newEntity nulls then error!
• both oldEntity and newEntity not null then EntityLogEvent.UPDATE>
• oldEntity not null then EntityLogEvent.DELETE>
• newEntity not null then EntityLogEvent.CREATE>

For each dto's property the EntityLogManager is used to allow log customization.

Throws:

java.lang.IllegalArgumentException - if both oldEntity and newEntity are null.

getEntityLogEvent

<E extends BaseEntity> EntityLogEvent getEntityLogEvent(E oldEntity,
                                                        E newEntity)

Calculates the EntityLogEvent according to the old and new entities.

log

void log(java.lang.String entityName,
         long entityId,
         java.lang.Long ownerEntityId,
         EntityLogType type,
         EntityLogEvent event,
         java.util.List<EntityPropertyLog> propertyLogs)

Creates and persists a new EntityLog with the provided parameters.