You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2021/03/31 08:01:14 UTC

[isis] branch master updated: ISIS-2573: resurrect sequence java-doc

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new 1454e84  ISIS-2573: resurrect sequence java-doc
1454e84 is described below

commit 1454e84e508ccb0c312e50936c217d5f4171b03f
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Mar 31 10:01:04 2021 +0200

    ISIS-2573: resurrect sequence java-doc
---
 .../metamodel/execution/InteractionInternal.java   | 32 ++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/execution/InteractionInternal.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/execution/InteractionInternal.java
index 72e08be..2040978 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/execution/InteractionInternal.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/execution/InteractionInternal.java
@@ -74,13 +74,30 @@ public interface InteractionInternal extends Interaction {
             final MetricsService metricsService,
             final Command command);
     
+   
     /**
-     * Framework internal use: holds current sequence number for executions.
+     * Numbers the executions (an action invocation or property edit) within
+     * a given {@link Interaction}.
+     *
+     * <p>
+     * Each {@link Interaction} is initiated by an execution of action
+     * invocation or a property edit.  Thereafter there could be multiple
+     * other executions as the result of nested calls using the
+     * {@link WrapperFactory}.
+     * </p>
+     *
+     * <p>
+     * Another possible reason is support for bulk action invocations.
+     * </p>
+     *
+     * @see Interaction
+     * @see WrapperFactory
      */
     LongAdder getExecutionSequence();
     
     /**
      * Framework internal use: generates sequence of numbers for executions.
+     * @see #getExecutionSequence()
      */
     default int getThenIncrementExecutionSequence() {
         final int counter = getExecutionSequence().intValue(); 
@@ -89,12 +106,23 @@ public interface InteractionInternal extends Interaction {
     }
     
     /**
-     * Framework internal use: holds current sequence number for transactions.
+     * Numbers the transactions within a given {@link Interaction}.
+     *
+     * <p>
+     * Each {@link Interaction} is executed within the context of a transaction, but
+     * the (occasionally) the transaction may be committed and a new one
+     * started as the result of the domain object using the
+     * {@link org.apache.isis.applib.services.xactn.TransactionService}.
+     * </p>
+     *
+     * @see Interaction
+     * @see org.apache.isis.applib.services.xactn.TransactionService
      */
     LongAdder getTransactionSequence();
     
     /**
      * Framework internal use: generates sequence of numbers for transactions.
+     * @see #getTransactionSequence()
      */
     default int getThenIncrementTransactionSequence() {
         final int counter = getTransactionSequence().intValue();