[isis] 02/04: ISIS-2264: adds some more docs

[da...@apache.org]

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

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

commit ba48396fd782290af3d5b44948047ec9bc69f25c
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jan 19 18:02:25 2020 +0000

    ISIS-2264: adds some more docs
---
 .../org/apache/isis/core/config/IsisConfiguration.java     | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
index f0df9c1..0e647be 100644
--- a/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
+++ b/core/config/src/main/java/org/apache/isis/core/config/IsisConfiguration.java
@@ -1146,7 +1146,7 @@ public class IsisConfiguration {
             @Data
             public static class ParameterLayout implements Applib.Annotation.ConfigPropsForPropertyOrParameterLayout {
                 /**
-                 * Defines the default position for the label for an action parameter..
+                 * Defines the default position for the label for an action parameter.
                  *
                  * <p>
                  *     Can be overridden on a case-by-case basis using
@@ -1172,6 +1172,18 @@ public class IsisConfiguration {
         @Data
         public static class MetaModel {
 
+            /**
+             * Whether domain objects to which the current user does not have visibility access should be rendered
+             * within collections or drop-down choices/autocompletes.
+             *
+             * <p>
+             *     One reason this filtering may be necessary is for multi-tenanted applications, whereby an end-user
+             *     should only be able to "see" what data that they own.  For efficiency, the application should
+             *     only query for objects that the end-user owns.  This configuration property acts as a safety net to
+             *     prevent the end-user from viewing domain objects <i>even if</i> those domain objects were rehydrated
+             *     from the persistence store.
+             * </p>
+             */
             private boolean filterVisibility = true;
 
             private final ProgrammingModel programmingModel = new ProgrammingModel();