BATM-6033 Improve javadocs

GENERALBYTESCOM · May 30, 2024 · fe751ff · fe751ff
1 parent 5f26ad9
commit fe751ff
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/...nsions_api/src/main/java/com/generalbytes/batm/server/extensions/IDepositPreparation.java b/...nsions_api/src/main/java/com/generalbytes/batm/server/extensions/IDepositPreparation.java
@@ -31,7 +31,7 @@ public interface IDepositPreparation {
     String getSafeSerialNumber();
 
     /**
-     * Deposit code used to identify the deposit.
+     * Deposit code used to identify the deposit. Equals to the RID of the order transaction.
      */
     String getDepositCode();
 
@@ -56,7 +56,7 @@ public interface IDepositPreparation {
     IIdentity getIdentity();
 
     /**
-     * Error message in case of error
+     * Error message in case of error.
      */
     String getErrorMessage();
 

diff --git a/...extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IDepositRequest.java b/...extensions_api/src/main/java/com/generalbytes/batm/server/extensions/IDepositRequest.java
@@ -30,7 +30,7 @@ public interface IDepositRequest {
     String getSafeSerialNumber();
 
     /**
-     * Deposit code used to identify the deposit.
+     * Deposit code used to identify the deposit. Equals to the RID of the order transaction.
      */
     String getDepositCode();
 
@@ -60,7 +60,7 @@ public interface IDepositRequest {
     IIdentity getIdentity();
 
     /**
-     * Error message in case of error
+     * Error message in case of error.
      */
     String getErrorMessage();
 

diff --git a/...sions_api/src/main/java/com/generalbytes/batm/server/extensions/ITransactionListener.java b/...sions_api/src/main/java/com/generalbytes/batm/server/extensions/ITransactionListener.java
@@ -131,7 +131,7 @@ default boolean isDepositPreparationApproved(IDepositPreparation preparation) {
     /**
      * Allows the operator to override following values in {@link IDepositPreparation}.
      * <ul>
-     *     <li>cashAmount</li>
+     *     <li>cashAmount</li> - cannot be higher than the provided amount, if yes will be reduced back to the provided amount
      *     <li>errorMessage</li>
      * </ul>
      * The method is called right before {@link ITransactionListener#isDepositPreparationApproved(IDepositPreparation)},
@@ -158,7 +158,7 @@ default boolean isTransactionApproved(IDepositRequest depositRequest) {
     /**
      * Allows the operator to override following values in {@link IDepositRequest}.
      * <ul>
-     *     <li>cashAmount</li>
+     *     <li>cashAmount</li> - cannot be higher than the provided amount, if yes will be reduced back to the provided amount
      *     <li>errorMessage</li>
      * </ul>
      * This method is called for both BUY and SELL transactions.