Add a bit of documentation

[controller.git] / opendaylight / md-sal / sal-common-api / src / main / java / org / opendaylight / controller / md / sal / common / api / TransactionStatus.java

diff --git a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java
index 92ff55175c4cb5ad948dfebc99d1bd0eacf6e32f..a8989c4ce865616d7515158407d228d922a50196 100644 (file)
--- a/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java
+++ b/opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/TransactionStatus.java
@@ -8,9 +8,26 @@
 package org.opendaylight.controller.md.sal.common.api;
 
 public enum TransactionStatus {
+    /**
+     * The transaction has been freshly allocated. The user is still accessing
+     * it and it has not been sealed.
+     */
     NEW,
+    /**
+     * The transaction has been completed by the user and sealed. It is currently
+     * awaiting execution.
+     */
     SUBMITED,
+    /**
+     * The transaction has been successfully committed to backing store.
+     */
     COMMITED,
+    /**
+     * The transaction has failed to commit due to some underlying issue.
+     */
     FAILED,
-    CANCELED
+    /**
+     * Currently unused.
+     */
+    CANCELED,
 }