From 146a0fb8b0e90f9196e569152f649baf60d6cc8f Mon Sep 17 00:00:00 2001
From: Joaquín Reñé <jrene@curisit.net>
Date: Tue, 07 Oct 2025 14:52:57 +0000
Subject: [PATCH] #4410 - Comments on classes

---
 securis/src/main/java/net/curisit/securis/db/common/ModificationTimestampEntity.java |   33 +++++++++++++++++++++++++++++++--
 1 files changed, 31 insertions(+), 2 deletions(-)

diff --git a/securis/src/main/java/net/curisit/securis/db/common/ModificationTimestampEntity.java b/securis/src/main/java/net/curisit/securis/db/common/ModificationTimestampEntity.java
index a59b56c..17084f8 100644
--- a/securis/src/main/java/net/curisit/securis/db/common/ModificationTimestampEntity.java
+++ b/securis/src/main/java/net/curisit/securis/db/common/ModificationTimestampEntity.java
@@ -1,10 +1,39 @@
+/*
+* Copyright @ 2013 CurisTEC, S.A.S. All Rights Reserved.
+*/
 package net.curisit.securis.db.common;
 
 import java.util.Date;
 
+/**
+* ModificationTimestampEntity
+* <p>
+* Contract for entities that track a <b>modification timestamp</b>.
+* Typical usage: attach {@code @EntityListeners(ModificationTimestampListener.class)}
+* so the value is updated automatically on persist/update.
+*
+* Methods:
+* - {@link #getModificationTimestamp()} exposes the timestamp.
+* - {@link #setModificationTimestamp(Date)} sets the timestamp.
+*
+* @author JRA
+* Last reviewed by JRA on Oct 7, 2025.
+*/
 public interface ModificationTimestampEntity {
 
-    public Date getModificationTimestamp();
+    /** 
+     * getModificationTimestamp<p>
+     * Return the last modification timestamp. 
+     * 
+     * @return modificationTimestamp
+     */
+    Date getModificationTimestamp();
 
-    public void setModificationTimestamp(Date modificationTimestamp);
+    /** 
+     * setModificationTimestamp<p>
+     * Set/update the last modification timestamp.
+     * 
+     * @param modificationTimestamp
+     */
+    void setModificationTimestamp(Date modificationTimestamp);
 }

--
Gitblit v1.3.2