From 215b326e807659b30c520478e8123a888df6d204 Mon Sep 17 00:00:00 2001
From: Thomas Knall <t.knall@datentechnik-innovation.com>
Date: Wed, 4 Feb 2015 13:19:53 +0100
Subject: Add comment to ProcessInstanceStore primary key field

---
 .../gv/egovernment/moa/id/process/dao/ProcessInstanceStore.java  | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'id/server/idserverlib/src/main/java')

diff --git a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/process/dao/ProcessInstanceStore.java b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/process/dao/ProcessInstanceStore.java
index 582f50427..d690c37bf 100644
--- a/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/process/dao/ProcessInstanceStore.java
+++ b/id/server/idserverlib/src/main/java/at/gv/egovernment/moa/id/process/dao/ProcessInstanceStore.java
@@ -19,6 +19,15 @@ import at.gv.egovernment.moa.id.process.ProcessInstanceState;
 @Table(name = "processinstance")
 public class ProcessInstanceStore {
 
+	/**
+	 * A process instance identifier qualifies as natural primary key by satisfying these requirements
+	 * ("unique, constant, required"):
+	 * <ul>
+	 * <li>unique value</li>
+	 * <li>never changes (immutable)</li>
+	 * <li>never {@code null}</li>
+	 * </ul>
+	 */
 	@Id
 	private String processInstanceId;
 
-- 
cgit v1.2.3