You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2020/01/20 09:52:40 UTC
[isis] 04/04: ISIS-2062: sync adoc
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 7f064b7f31f0ae7ac0db4bd89992299fc97880da
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 20 09:51:11 2020 +0000
ISIS-2062: sync adoc
also lombok fix for one class.
---
.../applib-ant/examples/annotation/Action.java | 2 +-
.../concurrent/ConcurrentTaskListTest.java | 4 +-
.../config/examples/generated/isis.applib.adoc | 143 ++++++++++++++++-----
.../examples/generated/isis.core.meta-model.adoc | 8 +-
.../generated/isis.core.meta-model.validator.adoc | 33 ++++-
5 files changed, 145 insertions(+), 45 deletions(-)
diff --git a/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Action.java b/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Action.java
index 85590ab..b9347b8 100644
--- a/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Action.java
+++ b/api/applib/src/main/adoc/modules/applib-ant/examples/annotation/Action.java
@@ -124,7 +124,7 @@ public @interface Action {
*
* <p>
* Specifying a processor requires that the implementation of {@link CommandService} provides a
- * custom implementation of {@link org.apache.isis.applib.services.command.Command} that additional extends
+ * custom implementation of {@link org.apache.isis.applib.services.command.Command} that additionally extends
* from {@link CommandWithDto}.
* </p>
*
diff --git a/core/commons/src/test/java/org/apache/isis/core/commons/internal/concurrent/ConcurrentTaskListTest.java b/core/commons/src/test/java/org/apache/isis/core/commons/internal/concurrent/ConcurrentTaskListTest.java
index 664af9c..e4c9b25 100644
--- a/core/commons/src/test/java/org/apache/isis/core/commons/internal/concurrent/ConcurrentTaskListTest.java
+++ b/core/commons/src/test/java/org/apache/isis/core/commons/internal/concurrent/ConcurrentTaskListTest.java
@@ -32,8 +32,8 @@ class ConcurrentTaskListTest {
void tasksShouldAllBeExecuted() {
val counter = new LongAdder();
-
- val tasks = _ConcurrentTaskList.named("Test")
+
+ _ConcurrentTaskList tasks = _ConcurrentTaskList.named("Test")
.addRunnable("1", counter::increment)
.addRunnable("2", counter::increment)
.addRunnable("3", counter::increment)
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
index 64201e0..e8454b3 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.applib.adoc
@@ -2,23 +2,47 @@
action-layout.css-class-fa. +
patterns
|
-|
+| Provides a mapping of patterns to font-awesome CSS classes, where the pattern is used to match against the name of the action method in order to determine a CSS class to use, for example on the action's menu icon if rendered by the Wicket viewer.
+
+Providing a default set of patterns encourages a common set of verbs to be used.
+
+The font awesome class for individual actions can be overridden using `org.apache.isis.applib.annotation.ActionLayout#cssClassFa()`.
+
| isis.applib.annotation. +
action-layout.css-class. +
patterns
|
-|
+| Provides a mapping of patterns to CSS classes, where the pattern is used to match against the name of the action method in order to determine a CSS class to use, for example on the action's button if rendered by the Wicket viewer.
+
+Providing a default set of patterns encourages a common set of verbs to be used.
+
+The CSS class for individual actions can be overridden using `org.apache.isis.applib.annotation.ActionLayout#cssClass()`.
+
| isis.applib.annotation.action. +
command
|
-|
+| The default for whether action invocations should be reified as a using the `org.apache.isis.applib.services.command.spi.CommandService, possibly so that the actual execution of the action can be deferred until later (background execution) or replayed against a copy of the system.
+
+In particular, the implementation of \{@link org.apache.isis.applib.services.command.Command represents the action invocation memento (obtained using as a \{@link org.apache.isis.schema.cmd.v2.CommandDto.
+
+This setting can be overridden on a case-by-case basis using \{@link org.apache.isis.applib.annotation.Action#command()`.
+
| isis.applib.annotation.action. +
domain-event.post-for-default
| true
-|
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever an action is being interacted with.
+
+Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases.
+
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the for the action in question:
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.domain.ActionDomainEvent.Noop ActionDomainEvent.Noop, then _no_ event is sent.
+* If set to some subtype of ActionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation.action. +
explicit
@@ -29,24 +53,44 @@ explicit
| isis.applib.annotation.action. +
publishing
|
-|
+| The default for whether action invocations should be sent through to the for publishing.
+
+The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(Interaction.Execution) publish method is called only once per transaction, with collecting details of the identity of the target object, the action invoked, the action arguments and the returned object (if any).
+
+This setting can be overridden on a case-by-case basis using \{@link org.apache.isis.applib.annotation.Action#publishing().
+
| isis.applib.annotation. +
collection-layout. +
default-view
|
-|
+| Defines the initial view to display collections when rendered.
+
+The value of this can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.CollectionLayout#defaultView()`. Note that this default configuration property is an enum and so defines only a fixed number of values, whereas the annotation returns a string; this is to allow for flexibility that individual viewers might support their own additional types. For example, the Wicket viewer supports which can render objects that have a date on top of a calendar view.
+
| isis.applib.annotation. +
collection-layout.paged
| 12
-|
+| Defines the default number of objects that are shown in a "parented" collection of a domain object, result of invoking an action.
+
+This can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.CollectionLayout#paged()`.
+
| isis.applib.annotation. +
collection.domain-event. +
post-for-default
| true
-|
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a collection is being interacted with.
+
+Up to two different events can be fired during an interaction, with the event's phase determining which (hide, disable)Subscribers can influence the behaviour at each of these phases.
+
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the for the collection action in question:
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.domain.CollectionDomainEvent.Noop CollectionDomainEvent.Noop, then _no_ event is sent.
+* If set to some subtype of CollectionDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
domain-object-layout. +
@@ -55,7 +99,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent() @DomainObjectLayout(cssClassEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#cssClassUiEvent() @DomainObjectLayout(cssClassEvent=...)` for the domain object in question.
* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -69,7 +113,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent() @DomainObjectLayout(iconEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#iconUiEvent() @DomainObjectLayout(iconEvent=...)` for the domain object in question.
* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -85,7 +129,7 @@ post-for-default
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent() @DomainObjectLayout(layoutEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#layoutUiEvent() @DomainObjectLayout(layoutEvent=...)` for the domain object in question.
* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -95,7 +139,10 @@ The algorithm for determining whether an event is sent depends on the value of t
| isis.applib.annotation. +
domain-object-layout.paged
| 25
-|
+| Defines the default number of objects that are shown in a "standalone" collection obtained as the result of invoking an action.
+
+This can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.DomainObjectLayout#paged()`.
+
| isis.applib.annotation. +
domain-object-layout. +
@@ -104,7 +151,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object is about to be rendered in the UI - thereby allowing subscribers to optionally change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent() @DomainObjectLayout(titleEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObjectLayout#titleUiEvent() @DomainObjectLayout(titleEvent=...)` for the domain object in question.
* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -116,7 +163,7 @@ domain-object.auditing
|
| The default for whether _domain entities_ should be audited or not (meaning that any changes are sent through to the
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getAuditing() DomainObject#getAuditing()
+This setting can be overridden on a case-by-case basis using `org.apache.isis.applib.annotation.DomainObject#auditing() DomainObject#getAuditing()`
Note: this applies only to domain entities, not view models.
@@ -128,7 +175,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain object has been created using
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.DomainObject#createdLifecycleEvent() @DomainObject(createdLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectCreatedEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -150,7 +197,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ has been loaded from the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(loadedLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(loadedLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectLoadedEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -166,7 +213,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ has been persisted (for the first time) to the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistedLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(persistedLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectPersistedEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -182,7 +229,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a domain _entity_ is about to be persisting (for the first time) to the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(persistingLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(persistingLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectPersistingEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -194,11 +241,11 @@ Note: this applies only to domain entities, not to view models.
| isis.applib.annotation. +
domain-object.publishing
|
-| The default for whether the properties of domain objects can be edited, or whether instead changed objects should be sent through to the for publishing.
+| The default for whether the identities of changed objects should be sent through to the for publishing.
The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(PublishedObjects) publish method is called only once per transaction, with collecting details of all changed domain objects.
-This setting can be overridden on a case-by-case basis using \{@link DomainObject#getPublishing() DomainObject#getPublishing().
+This setting can be overridden on a case-by-case basis using \{@link org.apache.isis.applib.annotation.DomainObject#publishing().
| isis.applib.annotation. +
@@ -208,7 +255,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ is about to be removed (that is, deleted) from the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(removingLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(removingLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectRemovingEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -226,7 +273,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ has been updated in the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatedLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(updatedLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectUpdatedEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -242,7 +289,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever a persistent domain _entity_ is about to be updated in the persistence store.
-The algorithm for determining whether an event is sent depends on the value of the @DomainObject(updatingLifecycleEvent=...) for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the @DomainObject(updatingLifecycleEvent=...) for the domain object in question.
* If set to some subtype of ObjectUpdatingEvent.Noop, then _no_ event is sent.
* If set to some subtype of ObjectCreatedEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -255,29 +302,58 @@ Note: this applies only to domain entities, not to view models.
parameter-layout. +
label-position
|
-|
+| Defines the default position for the label for an action parameter.
+
+Can be overridden on a case-by-case basis using
+
+If left as \{@link LabelPosition#NOT_SPECIFIED and not overridden, then the position depends upon the viewer implementation.
+
| isis.applib.annotation. +
property-layout. +
label-position
|
-|
+| Defines the default position for the label for a domain object property.
+
+Can be overridden on a case-by-case basis using
+
+If left as \{@link LabelPosition#NOT_SPECIFIED and not overridden, then the position depends upon the viewer implementation.
+
| isis.applib.annotation. +
property.command
|
-|
+| The default for whether property edits should be reified as a using the `org.apache.isis.applib.services.command.spi.CommandService, possibly so that the actual execution of the property edit can be deferred until later (background execution) or replayed against a copy of the system.
+
+In particular, the implementation of \{@link org.apache.isis.applib.services.command.Command represents the action invocation memento (obtained using as a \{@link org.apache.isis.schema.cmd.v2.CommandDto.
+
+This setting can be overridden on a case-by-case basis using \{@link org.apache.isis.applib.annotation.Action#command()`.
+
| isis.applib.annotation. +
property.domain-event. +
post-for-default
| true
-|
+| Influences whether an should be published (on the internal \{@link org.apache.isis.applib.services.eventbus.EventBusService) whenever an property is being interacted with.
+
+Up to five different events can be fired during an interaction, with the event's phase determining which (hide, disable, validate, executing and executed). Subscribers can influence the behaviour at each of these phases.
+
+The algorithm for determining whether (and what type of) an event is actually sent depends on the value of the for the property in question:
+
+* If set to some subtype of \{@link org.apache.isis.applib.events.domain.PropertyDomainEvent.Noop propertyDomainEvent.Noop, then _no_ event is sent.
+* If set to some subtype of propertyDomainEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
+* If set to any other subtype, then an event _is_ sent.
+
| isis.applib.annotation. +
property.publishing
|
-|
+| The default for whether property edits should be sent through to the for publishing.
+
+The service's \{@link org.apache.isis.applib.services.publish.PublisherService#publish(Interaction.Execution) publish method is called only once per transaction, with collecting details of the identity of the target object, the property edited, and the new value of the property.
+
+This setting can be overridden on a case-by-case basis using \{ @link org.apache.isis.applib.annotation.Property#publishing().
+
| isis.applib.annotation. +
view-model-layout. +
@@ -286,7 +362,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the CSS classes that are used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent() @ViewModelLayout(cssClassEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#cssClassUiEvent() @ViewModelLayout(cssClassEvent=...)` for the domain object in question:
* If set to some subtype of CssClassUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of CssClassUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -300,7 +376,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the icon that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent() @ViewModelLayout(iconEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#iconUiEvent() @ViewModelLayout(iconEvent=...)` for the domain object in question:
* If set to some subtype of IconUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of IconUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -316,7 +392,7 @@ post-for-default
If a different layout value has been set, then a layout in the form `Xxx.layout-zzz.xml` use used (where `zzz` is the name of the layout).
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent() @ViewModelLayout(layoutEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#layoutUiEvent() @ViewModelLayout(layoutEvent=...)` for the domain object in question:
* If set to some subtype of LayoutUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of LayoutUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -330,7 +406,7 @@ post-for-default
| true
| Influences whether an should be published (on the internal `org.apache.isis.applib.services.eventbus.EventBusService) whenever a view model (annotated with @ViewModel) is about to be rendered in the UI - thereby allowing subscribers to optionally change) the title that is used.
-The algorithm for determining whether an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent() @ViewModelLayout(titleEvent=...)` for the domain object in question.
+The algorithm for determining whether (and what type of) an event is sent depends on the value of the \{@link org.apache.isis.applib.annotation.ViewModelLayout#titleUiEvent() @ViewModelLayout(titleEvent=...)` for the domain object in question:
* If set to some subtype of TitleUiEvent.Noop, then _no_ event is sent.
* If set to some subtype of TitleUiEvent.Default, then an event is sent _if and only if_ this configuration setting is set.
@@ -341,5 +417,6 @@ The algorithm for determining whether an event is sent depends on the value of t
view-model.validation. +
semantic-checking.enable
|
-|
+| Whether to check for inconsistencies between the usage of \{@link org.apache.isis.applib.annotation.ViewModel, and \{@link org.apache.isis.applib.annotation.ViewModelLayout.
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.adoc
index f0596d8..2fa09ad 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.adoc
@@ -1,11 +1,15 @@
| isis.core.meta-model. +
filter-visibility
| true
-|
+| Whether domain objects to which the current user does not have visibility access should be rendered within collections or drop-down choices/autocompletes.
+
+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 _even if_ those domain objects were rehydrated from the persistence store.
+
| isis.core.meta-model. +
programming-model. +
ignore-deprecated
|
-|
+| If set, then any aspects of the programming model (as implemented by `FacetFactory`s that have been indicated as deprecated will simply be ignored/excluded from the metamodel.
+
diff --git a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
index 453ae53..fffd6f6 100644
--- a/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
+++ b/core/config/src/main/adoc/modules/config/examples/generated/isis.core.meta-model.validator.adoc
@@ -3,12 +3,18 @@ validator. +
action-collection-parameter- +
choices
| true
-|
+| Whether to validate that any actions that accept action parameters have either a corresponding choices or auto-complete for that action parameter, or are associated with a collection of the appropriate type.
+
| isis.core.meta-model. +
validator.allow-deprecated
| true
-|
+| This setting is used to determine whether the use of such deprecated features is allowed.
+
+If not allowed, then metamodel validation errors will be flagged.
+
+Note that this settings has no effect if the programming model has been configured to ignore deprecated features (because in this case the programming model facets simply won't be included in the introspection process.
+
| isis.core.meta-model. +
validator.check-module-extent
@@ -19,13 +25,19 @@ validator.check-module-extent
validator. +
ensure-unique-object-types
| true
-|
+| Whether to ensure that the object type of all objects (which can be set either explicitly using or `DomainService#objectType(), or can be inferred implicitly using a variety of mechanisms) must be unique with respect to all other object types.
+
+It is _highly advisable_ to leave this set as enabled (the default), and to also use explicit types (see \{@link #isExplicitObjectType()`.
+
| isis.core.meta-model. +
validator. +
explicit-object-type
|
-|
+| Whether to ensure that the object type of all objects must be specified explicitly, using either or `DomainService#objectType().
+
+It is _highly advisable_ to leave this set as enabled (the default). These object types should also (of course) be unique - that can be checked by setting the \{@link #isEnsureUniqueObjectTypes()` config property.
+
| isis.core.meta-model. +
validator.jaxb-view-model. +
@@ -71,7 +83,12 @@ variables-clause
| isis.core.meta-model. +
validator.no-params-only
|
-|
+| If set, then checks that the supports `hideXxx` and `disableXxx` methods for actions do not have take parameters.
+
+Historically, the programming model allowed these methods to accept the same number of parameters as the action method to which they relate, the rationale being for similarity with the `validateXxx` method. However, since these parameters serve no function, the programming model has been simplified so that these supporting methods are discovered if they have exactly no parameters.
+
+Note that this aspect of the programming model relates to the `hideXxx` and `disableXxx` supporting methods that relate to the entire method. Do not confuse these with the `hideNXxx` and `disableNXxx` supporting methods, which relate to the N-th parameter, and allow up to N-1 parameters to be passed in (allowing the Nth parameter to be dynamically hidden or disabled).
+
| isis.core.meta-model. +
validator.parallelize
@@ -82,11 +99,13 @@ validator.parallelize
| isis.core.meta-model. +
validator.mixins-only
| true
-|
+| If set, then domain services actions are not contributed to domain objects. @deprecated - in that in the future the programming model will simply not support contributed actions from domain services.
+
| isis.core.meta-model. +
validator. +
service-actions-only
| true
-|
+| If set, checks that any domain services have only actions associated with them, not properties or collections. @deprecated - in that in the future the programming model will simply not search for properties or collections of domain services.
+