This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-1.16.1
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 0b8d1516db68b18fcfc420114c65b105654929fb
Author: Dan Haywood <d...@haywood-associates.co.uk>
AuthorDate: Tue Feb 13 12:31:43 2018 +0000
ISIS-1813: fixes documentation links
---
.../guides/rgant/_rgant-Action_publishing.adoc | 2 +-
.../guides/rgant/_rgant-Discriminator.adoc | 4 ++--
..._rgant-DomainObject_autoCompleteRepository.adoc | 2 +-
.../rgant/_rgant-DomainObject_objectType.adoc | 4 ++--
.../rgant/_rgant-DomainObject_publishing.adoc | 2 +-
.../guides/rgant/_rgant-DomainService.adoc | 2 +-
.../asciidoc/guides/rgant/_rgant-Nullable.adoc | 10 ++++-----
.../asciidoc/guides/rgant/_rgant-Parameter.adoc | 2 +-
.../guides/rgant/_rgant-Parameter_optionality.adoc | 2 +-
.../guides/rgant/_rgant-PersistenceCapable.adoc | 4 ++--
.../rgant/_rgant-PropertyLayout_unchanging.adoc | 2 +-
.../guides/rgant/_rgant-Property_optionality.adoc | 2 +-
.../guides/rgant/_rgant-Property_publishing.adoc | 2 +-
.../asciidoc/guides/rgant/_rgant-ViewModel.adoc | 2 +-
.../guides/rgant/_rgant-ViewModel_objectType.adoc | 6 +++---
.../_rgcms_classes_AppManifest2-bootstrapping.adoc | 4 ++--
...gcms_classes_domainevent_ActionDomainEvent.adoc | 2 +-
..._classes_domainevent_CollectionDomainEvent.adoc | 2 +-
...ms_classes_domainevent_PropertyDomainEvent.adoc | 2 +-
.../rgcms/_rgcms_methods_reserved_getId.adoc | 2 +-
.../asciidoc/guides/rgcms/_rgcms_schema-chg.adoc | 2 +-
.../_rgsvc_metadata-api_MetamodelService.adoc | 2 +-
...esentation-layer-spi_ContentMappingService.adoc | 2 +-
...entation-layer-spi_TableColumnOrderService.adoc | 2 +-
...ugfun_building-blocks_events_domain-events.adoc | 2 +-
...un_building-blocks_events_lifecycle-events.adoc | 2 +-
.../_ugfun_building-blocks_events_ui-events.adoc | 4 ++--
.../ugfun/_ugfun_programming-model_actions.adoc | 24 +++++++++++-----------
...fun_programming-model_domain-services_menu.adoc | 14 ++++++-------
.../_ugfun_programming-model_inject-services.adoc | 2 +-
.../ugfun/_ugfun_programming-model_mixins.adoc | 2 +-
...fun_programming-model_mixins_inferred-name.adoc | 2 +-
.../ugfun/_ugfun_ui-hints_eager-rendering.adoc | 4 ++--
.../_ugfun_ui-hints_object-titles-and-icons.adoc | 6 +++---
.../_migration-notes_1.10.0-to-1.11.0.adoc | 2 +-
.../_migration-notes_1.12.0-to-1.13.0.adoc | 12 +++++------
.../_migration-notes_1.14.0-to-1.15.0.adoc | 2 +-
37 files changed, 73 insertions(+), 73 deletions(-)
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
index f305d97..59e3205 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Action_publishing.adoc
@@ -11,7 +11,7 @@ The `publishing()` attribute determines whether and how an
action invocation is
implementation of a
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`])
or
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
This attribute is also
supported for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain
objects], where it controls whether changed objects
-are published as events, and for
xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`],
where it controls
+are published as events, and for
xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`],
where it controls
whether property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the
state of the Isis application.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
index ebe4ec4..25517b2 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Discriminator.adoc
@@ -49,9 +49,9 @@ has an object type of `custmgmt.Customer`.
The rules of precedence for determining a domain object's object type are:
-1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`]
+1. xref:../rgant/rgant.adoc#_rgant-Discriminator[`@Discriminator`]
2. `@DomainObject#objectType`
-3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+3. xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+
If both `schema` and `table` are defined, then the value is "`schema.table`".
If only `schema` is defined, then the value is "`schema.className`".
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc
index 2fa8299..938086a 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc
@@ -78,7 +78,7 @@ public class Customers {
----
<1> end-user must enter minimum number of characters to trigger the query
-The autocomplete action can also be a regular method, annotated using
xref:../rgant/rgant.adoc#_rgant_Programmatic[`@Programmatic`]:
+The autocomplete action can also be a regular method, annotated using
xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`]:
[source,java]
----
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc
index 0d0aff2..50f2b6c 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc
@@ -39,9 +39,9 @@ public class Order {
The rules of precedence are:
-1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`]
+1. xref:../rgant/rgant.adoc#_rgant-Discriminator[`@Discriminator`]
2. `@DomainObject#objectType`, or
xref:../rgant/rgant.adoc#_rgant_aaa_deprecated[`@ObjectType`] (deprecated)
-3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+3. xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+
If both `schema` and `table` are defined, then the value is "`schema.table`".
If only `schema` is defined, then the value is "`schema.className`".
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
index 7cd7f3d..11ed8ba 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc
@@ -10,7 +10,7 @@ The `publishing()` attribute determines whether and how a
modified object instan
implementation of a
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`])
or
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
This attribute is also supported
for xref:../rgant/rgant.adoc#_rgant-Action_publishing[actions], where it
controls whether action invocations are published as
-events, and for
xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`],
where it controls whether
+events, and for
xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`],
where it controls whether
property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the
state of the Isis application.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc
index 77db9f0..ef6cdb7 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc
@@ -29,7 +29,7 @@ The table below summarizes the annotation's attributes.
|xref:../rgant/rgant.adoc#_rgant-DomainService_objectType[`objectType()`]
|
-|equivalent to
xref:../rgant/rgant.adoc#_rgant_DomainObject_objectType[`@DomainObject#objectType()`],
specifies the objectType of the service.
+|equivalent to
xref:../rgant/rgant.adoc#_rgant-DomainObject_objectType[`@DomainObject#objectType()`],
specifies the objectType of the service.
The instanceId for services is always "1".
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc
index 51c4cb0..b4bfac9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc
@@ -34,16 +34,16 @@ public Customer updateName(@javax.annotation.Nullable final
String name) {
----
Apache Isis does provide several other ways to specify optionality: using the
-xref:../rgant/rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`]
/
-xref:../rgant/rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`]
annotation. For properties, the optionality
-can also be inferred from the
xref:../rgant/rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`]
attribute.
+xref:../rgant/rgant.adoc#_rgant-Property_optionality[`@Property#optionality()`]
/
+xref:../rgant/rgant.adoc#_rgant-Parameter_optionality[`@Parameter#optionality()`]
annotation. For properties, the optionality
+can also be inferred from the
xref:../rgant/rgant.adoc#_rgant-Column_allowsNull[`@Column#allowsNull()`]
attribute.
[TIP]
====
See the
-xref:../rgant/rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`]
documentation for a much fuller discussion on
+xref:../rgant/rgant.adoc#_rgant-Property_optionality[`@Property#optionality()`]
documentation for a much fuller discussion on
the relationship between using the Apache Isis annotations vs
-xref:../rgant/rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`].
+xref:../rgant/rgant.adoc#_rgant-Column_allowsNull[`@Column#allowsNull()`].
====
If more than one method is specified then the framework will validate that
there are no incompatibilities (and fail to
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc
index 9f2d280..699859b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc
@@ -34,7 +34,7 @@ The table below summarizes the annotation's attributes.
|`minLength()`
|Positive integer
-|Deprecated; use xref:../rgant/rgant.adoc#_rgant_minLength[`@MinLength`]
instead. +
+|Deprecated; use xref:../rgant/rgant.adoc#_rgant-MinLength[`@MinLength`]
instead. +
Can be used to specify the minimum length for
xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`]
supporting method; but because this _is a_ supporting method rather than the
action method itself, we now feel it is misleading to use the `@Parameter`
annotation in this situation.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc
index 9d59d04..2b82316 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter_optionality.adoc
@@ -38,5 +38,5 @@ public class Customer {
[NOTE]
====
-It is also possible to specify optionality using
xref:../rgant/rgant.adoc#_rgant_Nullable[`@Nullable`] annotation.
+It is also possible to specify optionality using
xref:../rgant/rgant.adoc#_rgant-Nullable[`@Nullable`] annotation.
====
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc
index 53b0eaa..8b88cec 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PersistenceCapable.adoc
@@ -77,9 +77,9 @@ does _not_ correspond to an object type, because the
`schema()` attribute is mis
The rules of precedence for determining a domain object's object type are:
-1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`]
+1. xref:../rgant/rgant.adoc#_rgant-Discriminator[`@Discriminator`]
2. `@DomainObject#objectType`
-3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+3. xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+
If both `schema` and `table` are defined, then the value is "`schema.table`".
If only `schema` is defined, then the value is "`schema.className`".
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_unchanging.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_unchanging.adoc
index f158c9c..054d721 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_unchanging.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-PropertyLayout_unchanging.adoc
@@ -15,7 +15,7 @@ Note that for this to work, the viewer will also ensure that
none of the propert
[NOTE]
====
-Design note: we considered implementing this an "immutable" flag on the
xref:rgant.adoc#_rgant_Property[`@Property`] annotation (because this flag is
typically appropriate for immutable/unchanging properties of a domain object).
+Design note: we considered implementing this an "immutable" flag on the
xref:rgant.adoc#_rgant-Property[`@Property`] annotation (because this flag is
typically appropriate for immutable/unchanging properties of a domain object).
However, we decided not to do that, on the basis that it might be interpreted
as having a deeper impact within the framework than simply a hint for rendering.
====
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc
index a01c409..f7aa6e4 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_optionality.adoc
@@ -129,6 +129,6 @@ public class Customer {
[NOTE]
====
-It is also possible to specify optionality using
xref:../rgant/rgant.adoc#_rgant_Nullable[`@Nullable`] annotation.
+It is also possible to specify optionality using
xref:../rgant/rgant.adoc#_rgant-Nullable[`@Nullable`] annotation.
====
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
index 74713e3..6cbf9fa 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Property_publishing.adoc
@@ -11,7 +11,7 @@ The `publishing()` attribute determines whether and how a
property edit is publi
of a
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublishingService[`PublishingService`])
or
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`].
This attribute is also supported
for xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[domain objects],
where it controls whether changed objects are
-published as events, and for
xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`],
where it controls
+published as events, and for
xref:../rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`],
where it controls
whether property edits are published as events.
A common use case is to notify external "downstream" systems of changes in the
state of the Isis application.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel.adoc
index 4f46d82..258cedd 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel.adoc
@@ -64,5 +64,5 @@ If you are using view models heavily, you may wish to
restrict yourself to just
====
The `@ViewModel` does not allow the objectType to be specified, meaning that
it is incompatible with the metamodel validation check ennabled by the
xref:../rgcfg/rgcfg.adoc#__rgcfg_configuring-core_metamodel-validation[`explicitObjectType`]
configuration property.
-Instead, use
xref:../rgant/rgant.adoc#_rgant_DomainObject_nature[`@DomainObject#nature()`]
with `Nature.VIEW_MODEL`, and specify
xref:../rgant/rgant.adoc#_rgant_DomainObject_objectType[`@DomainObject#objectType()`].
+Instead, use
xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature()`]
with `Nature.VIEW_MODEL`, and specify
xref:../rgant/rgant.adoc#_rgant-DomainObject_objectType[`@DomainObject#objectType()`].
====
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel_objectType.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel_objectType.adoc
index baf9c56..1b02e7e 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel_objectType.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-ViewModel_objectType.adoc
@@ -39,9 +39,9 @@ public class Order {
The rules of precedence are:
-1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`]
-2. `@DomainObject#objectType`, or
xref:../rgant/rgant.adoc#_rgant_ViewModel_objectType[`@ViewModel#objectType()`],
or xref:../rgant/rgant.adoc#_rgant_aaa_deprecated[`@ObjectType`] (deprecated)
-3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+1. xref:../rgant/rgant.adoc#_rgant-Discriminator[`@Discriminator`]
+2. `@DomainObject#objectType`, or
xref:../rgant/rgant.adoc#_rgant-ViewModel_objectType[`@ViewModel#objectType()`],
or xref:../rgant/rgant.adoc#_rgant_aaa_deprecated[`@ObjectType`] (deprecated)
+3. xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`],
if at least the `schema` attribute is defined. +
+
If both `schema` and `table` are defined, then the value is "`schema.table`".
If only `schema` is defined, then the value is "`schema.className`".
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
index 56521c5..dada1fa 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest2-bootstrapping.adoc
@@ -13,7 +13,7 @@ Each `Module` can express its immediate dependencies (using
`Module#getDependenc
Each `Module` can also optionally define additional dependencies on "legacy"
modules (that is, those that do not implement `Module`) using
`Module#getAdditionalModules()` method.
These legacy modules simply define a package to search for entities and domain
services.
-Legacy domain services can also be explicitly identified using
`Module#getAdditionalServices()` method; such services do _not_ need to be
annotated with xref:../rgant/rgant.adoc#_rgant_DomainService[`@DomainService`].
+Legacy domain services can also be explicitly identified using
`Module#getAdditionalServices()` method; such services do _not_ need to be
annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`].
A `Module` can also declare additional configuration properties (using either
`Module#getIndividualConfigProps()` or `Module#getPropertyResources()`) that
should be contributed to the overall set of configuration properties used
to bootstrap the application.
@@ -120,7 +120,7 @@ public interface Module {
The framework calculates a full set of transitive dependencies from this.
<2> Support for "legacy" modules that do not implement `Module`.
These are added to the set of packages to scan for entities and domain
services.
-<3>Each `Module` can define additional "legacy" domain services that have not
been defined within modules,or that have not been annotated with
xref:../rgant/rgant.adoc#_rgant_DomainService[`@DomainService`].
+<3>Each `Module` can define additional "legacy" domain services that have not
been defined within modules,or that have not been annotated with
xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`].
<4> Optionally each `Module` can define a
xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`] which holds
immutable "reference data".
These are automatically executed whenever running integration tests (but are
ignored when bootstrapping the runtime as a webapp.
<5> Similarly, optionally each `Module` can define a tear-down
xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`], used to
remove the contents of _all_ entities (both reference data and
operational/transactional data).
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
index 81d8819..3a1b1d0 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
@@ -44,7 +44,7 @@ public abstract class ActionDomainEvent<S> extends
AbstractDomainEvent<S> {
public Object getReturnValue(); //
<7>
}
----
-<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant_Action_domainEvent[`@Action#domainEvent()`]
+<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`]
annotation attribute.
Whether this raises an event or not depends upon the
`isis.reflector.facet.actionAnnotation.domainEvent.postForDefault`
configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event
should _not_ be posted (irrespective of the configuration property setting).
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
index cf7c7e6..2bc02d7 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
@@ -38,7 +38,7 @@ public abstract class CollectionDomainEvent<S,T> extends
AbstractDomainEvent<S>
public Of getOf(); // <5>
}
----
-<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant_Collection_domainEvent[`@Collection#domainEvent()`]
annotation attribute.
+<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`]
annotation attribute.
Whether this raises an event or not depends upon the
`isis.reflector.facet.collectionAnnotation.domainEvent.postForDefault`
configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event
should _not_ be posted (irrespective of the configuration property setting).
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
index ceeb6c7..eb8de82 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
@@ -36,7 +36,7 @@ public abstract class PropertyDomainEvent<S,T> extends
AbstractDomainEvent<S> {
public T getNewValue(); // <5>
}
----
-<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`]
annotation attribute.
+<1> The `Default` nested static class is the default for the
xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`]
annotation attribute.
Whether this raises an event or not depends upon the
`isis.reflector.facet.propertyAnnotation.domainEvent.postForDefault`
configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event
should _not_ be posted (irrespective of the configuration property setting).
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
index feae751..595b435 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
@@ -37,7 +37,7 @@ public class OrderMenu {
The rules of precedence are:
-1.
xref:../rgant/rgant.adoc#_rgant_DomainService_objectType[`@DomainService#objectType()`]
+1.
xref:../rgant/rgant.adoc#_rgant-DomainService_objectType[`@DomainService#objectType()`]
2. xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`]
3. The fully qualified class name.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
index dab9938..7b6b3b7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
@@ -12,7 +12,7 @@ metrics counts (number of objects loaded, number of object
properties modified),
An instance of the DTO (corresponding to this schema) is used within the
xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-spi_PublisherService[`PublisherService`]
SPI, identifying changed objects that are to be
-published (as per
xref:../rgant/rgant.adoc#_rgant_DomainObject_publishing[`@DomainObject#publishing()`]
or equivalent).
+published (as per
xref:../rgant/rgant.adoc#_rgant-DomainObject_publishing[`@DomainObject#publishing()`]
or equivalent).
== `changesDto`
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
index b610a59..222e67e 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_metadata-api_MetamodelService.adoc
@@ -58,7 +58,7 @@ public interface MetaModelService4 {
<6> whether to throw an exception or return `Sort.UNKNOWN` if the object type
is not recognized. (The overloads with no `Mode` parameter default to strict
mode).
<7> returns the `AppManifest` used to bootstrap the application.
If an `AppManifest2` was used (from a `Module`), then this is also returned
(else just `null`).
-<8> obtain an implementation of `CommandDtoProcessor` (if any) as per an
xref:../rgant/rgant.adoc#_rgant_Action_command[`@Action#commandDtoProcessor()`]
or
xref:../rgant/rgant.adoc#_rgant_Property_command[`@Property#commandDtoProcessor()`].
+<8> obtain an implementation of `CommandDtoProcessor` (if any) as per an
xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#commandDtoProcessor()`]
or
xref:../rgant/rgant.adoc#_rgant-Property_command[`@Property#commandDtoProcessor()`].
+
This is used by the
xref:rgsvc.adoc#_rgsvc_presentation-layer-spi_ContentMappingService_implementations[framework-provided
implementations] of `ContentMappingService`.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_ContentMappingService.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_ContentMappingService.adoc
index f2ade47..348bd99 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_ContentMappingService.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_ContentMappingService.adoc
@@ -54,7 +54,7 @@ For framework implementations of `ContentMappingService`
allow domain service ac
* `o.a.i.applib.conmap.ContentMappingServiceForCommandDto` will map any single
instnce of a `CommandWithDto` into a `CommandDto` XML document
* `o.a.i.applib.conmap.ContentMappingServiceForCommandsDto` will map list of
``CommandWithDto``s into a `CommandsDto` XML document, and will wrap any single
instance of a `CommandWithDto` into a singleton list and thence into a
`CommandsDto` XML document.
-If the action invocation or property edit represent provides an implementation
of a `CommandDtoProcessor` (by way of
xref:../rgant/rgant.adoc#_rgant_Action_command[`@Action#commandDtoProcessor()`]
or
xref:../rgant/rgant.adoc#_rgant_Property_command[`@Property#commandDtoProcessor()`])
then this is also called to post-process the persisted `CommandDto` if
required.
+If the action invocation or property edit represent provides an implementation
of a `CommandDtoProcessor` (by way of
xref:../rgant/rgant.adoc#_rgant-Action_command[`@Action#commandDtoProcessor()`]
or
xref:../rgant/rgant.adoc#_rgant-Property_command[`@Property#commandDtoProcessor()`])
then this is also called to post-process the persisted `CommandDto` if
required.
A typical use case for this is to dynamically add in serialized ``Blob``s or
``Clob``s, the values of which are not captured by default in `CommandDto`.
To support the writing of custom implementations of this interface, the
framework also provides `ContentMappingService.Util` which includes a couple of
convenience utilities:
diff --git
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_TableColumnOrderService.adoc
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_TableColumnOrderService.adoc
index 36c7b55..2a71d03 100644
---
a/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_TableColumnOrderService.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/rgsvc/_rgsvc_presentation-layer-spi_TableColumnOrderService.adoc
@@ -29,7 +29,7 @@ public interface TableColumnOrderService {
<1> for the parent collection owned by the specified parent and collection Id,
return the set of property ids in the same or other order.
<2> for the standalone collection of the specified type, return the set of
property ids in the same or other order, else return `null` if provides no
reordering.
-There can be multiple implementations of `TableColumnOrderService` registered,
ordered as per
xref:../rgant/rgant.adoc#_rgant_DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`].
+There can be multiple implementations of `TableColumnOrderService` registered,
ordered as per
xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`].
The ordering provided by the first such service that returns a non-`null`
value will be used.
If all provided implementations return `null`, then the framework will
fallback to a default implementation.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_domain-events.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_domain-events.adoc
index 6174ebd..31089f3 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_domain-events.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_domain-events.adoc
@@ -7,7 +7,7 @@
Domain events are fired -- through the internal
xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[event bus] --
for every user interaction with each object member (property, collection or
action).
-By default, rendering a property causes a `PropertyDomainEvent` to be fired,
though the
xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`]
attribute allows a custom subclass to be specified if necessary.
+By default, rendering a property causes a `PropertyDomainEvent` to be fired,
though the
xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`]
attribute allows a custom subclass to be specified if necessary.
Similarly, rendering a collection causes a `CollectionDomainEvent` to be
fired, and rendering an action causes an `ActionDomainEvent` to be fired.
In fact, each event can be fired up to five times, with the event's
`getEventPhase()` method indicating to the subscriber the phase:
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_lifecycle-events.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_lifecycle-events.adoc
index 13239ea..b4c0059 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_lifecycle-events.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_lifecycle-events.adoc
@@ -35,6 +35,6 @@ There is no lifecycle event for object creating because the
framework doesn't kn
For example, if annotated with
xref:../rgant/rgant.adoc#_rgant_DomainObject_updatingLifecycleEvent[`@DomainObjectLayout#updatingLifecycleEvent()`],
the appropriate (subclass of) `ObjectUpdatingEvent` will be emitted.
- Similarly for
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_iconUiEvent[`iconUiEvent()`]
and
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`].
+ Similarly for
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`iconUiEvent()`]
and
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`].
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_ui-events.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_ui-events.adoc
index 8b9cd25..f043406 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_ui-events.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events_ui-events.adoc
@@ -11,8 +11,8 @@
xref:../ugfun/ugfun.adoc#_ugfun_ui-hints_object-titles-and-icons[Normally] the c
However, UI events allow this title and icon to be provided instead by a
subscriber.
UI events have higher precedence than the other mechanisms of supplying a
title.
-If annotated with
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`],
the appropriate (subclass of) `TitleUiEvent` will be emitted.
- Similarly for
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_iconUiEvent[`iconUiEvent()`]
and
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`].
+If annotated with
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`],
the appropriate (subclass of) `TitleUiEvent` will be emitted.
+ Similarly for
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`iconUiEvent()`]
and
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`].
This can be particularly useful for
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_view-models_jaxb[JAXB-style
view models] which are used as DTOs and so must have no dependencies on the
rest of the Apache Isis framework.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_actions.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_actions.adoc
index d6d9b49..b48ab06 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_actions.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_actions.adoc
@@ -88,7 +88,7 @@ ProductRepository productRepository;
<1> Supporting `autoComplete` method.
The "0" in the name means that this corresponds to parameter 0 of the
"addToBasket" action (ie `Product`).
It is also required to return a Collection of that type.
-<2> The xref:../rgant/rgant.adoc#_rgant_MinLength[`@MinLength`] annotation
defines how many characters the end-user must enter before performing a search.
+<2> The xref:../rgant/rgant.adoc#_rgant-MinLength[`@MinLength`] annotation
defines how many characters the end-user must enter before performing a search.
<3> The implementation delegates to an injected repository service. This is
typical.
Note that it is also valid to define "choices" and "autoComplete" for value
types (such as `quantity`, above); it just isn't as common to do so.
@@ -160,14 +160,14 @@ public List<Product>
autoComplete0AddToBasket(@MinLength(3) String searchTerm) {
}
----
-As the example suggests, any collection parameter type must provide a way to
select items, either by way of a "choices" or "autoComplete" supporting method
or alternatively defined globally using
xref:../rgant/rgant.adoc#_rgant_DomainObject[`@DomainObject`] on the referenced
type (described
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_actions_reference-parameter-types_removing-boilerplate[above]).
+As the example suggests, any collection parameter type must provide a way to
select items, either by way of a "choices" or "autoComplete" supporting method
or alternatively defined globally using
xref:../rgant/rgant.adoc#_rgant-DomainObject[`@DomainObject`] on the referenced
type (described
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_actions_reference-parameter-types_removing-boilerplate[above]).
[[__ugfun_programming-model_actions_optional-parameters]]
== Optional Parameters
-Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_optional-properties[optionality
of properties] is defined using
xref:../rgant/rgant.adoc#_rgant_Column_allowsNull[`@javax.jdo.annotations.Column#allowsNull()`],
that JDO annotation cannot be applied to parameter types.
-Instead, either the xref:../rgant/rgant.adoc#_rgant_Nullable[`@Nullable`]
annotation or the
xref:../rgant/rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`]
annotation/attribute is used.
+Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_optional-properties[optionality
of properties] is defined using
xref:../rgant/rgant.adoc#_rgant-Column_allowsNull[`@javax.jdo.annotations.Column#allowsNull()`],
that JDO annotation cannot be applied to parameter types.
+Instead, either the xref:../rgant/rgant.adoc#_rgant-Nullable[`@Nullable`]
annotation or the
xref:../rgant/rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`]
annotation/attribute is used.
For example:
@@ -195,8 +195,8 @@ See also
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_properties-vs-paramet
[[__ugfun_programming-model_actions_string-parameters]]
== ``String`` Parameters (Length)
-Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_datatypes_strings[length
of string properties] is defined using
xref:../rgant/rgant.adoc#_rgant_Column_length[`@javax.jdo.annotations.Column#length()`],
that JDO annotation cannot be applied to parameter types.
-Instead, the
xref:../rgant/rgant.adoc#_rgant_Parameter_maxLength[`@Parameter#maxLength()`]
annotation/attribute is used.
+Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_datatypes_strings[length
of string properties] is defined using
xref:../rgant/rgant.adoc#_rgant-Column_length[`@javax.jdo.annotations.Column#length()`],
that JDO annotation cannot be applied to parameter types.
+Instead, the
xref:../rgant/rgant.adoc#_rgant-Parameter_maxLength[`@Parameter#maxLength()`]
annotation/attribute is used.
For example:
@@ -222,8 +222,8 @@ public Customer updateName(
return this;
}
----
-<1> Specifies the property length using the JDO
xref:../rgant/rgant.adoc#_rgant_Column_length[`@Column#length()`] annotation
-<2> Specifies the parameter length using the (Apache Isis)
xref:../rgant/rgant.adoc#_rgant_Parameter_maxLength[`@Parameter#maxLength()`]
annotation
+<1> Specifies the property length using the JDO
xref:../rgant/rgant.adoc#_rgant-Column_length[`@Column#length()`] annotation
+<2> Specifies the parameter length using the (Apache Isis)
xref:../rgant/rgant.adoc#_rgant-Parameter_maxLength[`@Parameter#maxLength()`]
annotation
[IMPORTANT]
====
@@ -236,8 +236,8 @@ See also
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_properties-vs-paramet
[[__ugfun_programming-model_actions_bigdecimal-parameters]]
== ``BigDecimal``s (Precision)
-Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_datatypes_bigdecimals[precision
of BigDecimal properties] is defined using
xref:../rgant/rgant.adoc#_rgant_Column_scale[`@javax.jdo.annotations.Column#scale()`],
that JDO annotation cannot be applied to parameter types.
-Instead, the
xref:../rgant/rgant.adoc#_rgant_Digits_fraction[`@javax.validation.constraints.Digits#fraction()`]
annotation/attribute is used.
+Whereas the
xref:../ugfun/ugfun.adoc#__ugfun_programming-model_properties_datatypes_bigdecimals[precision
of BigDecimal properties] is defined using
xref:../rgant/rgant.adoc#_rgant-Column_scale[`@javax.jdo.annotations.Column#scale()`],
that JDO annotation cannot be applied to parameter types.
+Instead, the
xref:../rgant/rgant.adoc#_rgant-Digits_fraction[`@javax.validation.constraints.Digits#fraction()`]
annotation/attribute is used.
For example:
@@ -255,8 +255,8 @@ public Order updateDiscount(
return this;
}
----
-<1> Specifies the property precision using
xref:../rgant/rgant.adoc#_rgant_Column_scale[`@Column#scale()`]
-<2> Specifies the corresponding parameter precision using
xref:../rgant/rgant.adoc#_rgant_Digits_fraction[`@Digits#fraction()`].
+<1> Specifies the property precision using
xref:../rgant/rgant.adoc#_rgant-Column_scale[`@Column#scale()`]
+<2> Specifies the corresponding parameter precision using
xref:../rgant/rgant.adoc#_rgant-Digits_fraction[`@Digits#fraction()`].
See also
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_properties-vs-parameters[properties
vs parameters].
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_domain-services_menu.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_domain-services_menu.adoc
index e6ffc51..f2fb8e5 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_domain-services_menu.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_domain-services_menu.adoc
@@ -59,22 +59,22 @@ public class CustomerMenu {
protected CustomerRepository customerRepository; // <4>
}
----
-<1> The (Apache Isis)
xref:../rgant/rgant.adoc#_rgant_DomainService[`@DomainService`] annotation is
used to identify the class as a domain service.
+<1> The (Apache Isis)
xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`] annotation is
used to identify the class as a domain service.
Apache Isis scans the classpath looking for classes with this annotation, so
there very little configuration other than to tell the framework which packages
to scan underneath.
The `VIEW_MENU_ONLY` nature indicates that this service's actions should be
exposed as menu items.
-<2> The
xref:../rgant/rgant.adoc#_rgant_DomainServiceLayout[`@DomainServiceLayout`]
annotation provides UI hints.
-The menu is named "Customers" (otherwise it would have defaulted to "Customer
Menu", based on the class name, while the
xref:../rgant/rgant.adoc#_rgant_DomainServiceLayout_menuOrder[`menuOrder`]
attribute determines the order of the menu with respect to other menu services.
-<3> The `findByName` method is annotated with various Apache Isis annotations
(xref:../rgant/rgant.adoc#_rgant_Action[`@Action`],
xref:../rgant/rgant.adoc#_rgant_ActionLayout[`@ActionLayout`] and
xref:../rgant/rgant.adoc#_rgant_MemberOrder[`@MemberOrder`] and is itself
rendered in the UI as a "Find By Name" menu item underneath the "Simple
Objects" menu.
-<4> The xref:../rgant/rgant.adoc#_rgant_ParameterLayout[`@ParameterLayout`]
provides metadata for the parameter itself, in this case its name.
+<2> The
xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout[`@DomainServiceLayout`]
annotation provides UI hints.
+The menu is named "Customers" (otherwise it would have defaulted to "Customer
Menu", based on the class name, while the
xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder`]
attribute determines the order of the menu with respect to other menu services.
+<3> The `findByName` method is annotated with various Apache Isis annotations
(xref:../rgant/rgant.adoc#_rgant-Action[`@Action`],
xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] and
xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] and is itself
rendered in the UI as a "Find By Name" menu item underneath the "Simple
Objects" menu.
+<4> The xref:../rgant/rgant.adoc#_rgant-ParameterLayout[`@ParameterLayout`]
provides metadata for the parameter itself, in this case its name.
<5> the action implementation delegates to an injected repository.
The framework can inject into not just other domain services but will also
automatically into domain entities and view models.
There is further discussion of service injection
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_inject-services[below].
-<6> xref:../rgant/rgant.adoc#_rgant_Action_restrictTo[Prototype] actions are
rendered only in prototyping mode.
+<6> xref:../rgant/rgant.adoc#_rgant-Action_restrictTo[Prototype] actions are
rendered only in prototyping mode.
A "list all" action such as this can be useful when exploring the domain with
a small dataset.
[TIP]
====
-Annotating action parameters with
xref:../rgant/rgant.adoc#_rgant_ParameterLayout_named[`@ParameterLayout#named()`]
can become somewhat tiresome.
+Annotating action parameters with
xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[`@ParameterLayout#named()`]
can become somewhat tiresome.
You can avoid doing this by configuring the (non-ASF)
link:http://platform.incode.org[Incode Platform^]'s paraname8 metamodel
extension.
====
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_inject-services.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_inject-services.adoc
index abcc322..153011e 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_inject-services.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_inject-services.adoc
@@ -12,7 +12,7 @@ Sometimes there may be multiple services that implement a
single type.
This is common for example for SPI service, whereby one module defines an SPI
service, and other module(s) in the application implement that service.
To support this, the framework also allows lists of services to be injected.
-When there are multiple service implementations of a given type, the framework
will inject the service with highest priority, as defined through
xref:../rgant/rgant.adoc#_rgant_DomainService_menuOrder[`@DomainService#menuOrder()`]
(even for domain services that are not menus), lowest first.
+When there are multiple service implementations of a given type, the framework
will inject the service with highest priority, as defined through
xref:../rgant/rgant.adoc#_rgant-DomainService_menuOrder[`@DomainService#menuOrder()`]
(even for domain services that are not menus), lowest first.
If a list of services is injected, then that list will be ordered according to
`menuOrder`, again lowest first.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins.adoc
index e585f5c..77ad831 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins.adoc
@@ -8,7 +8,7 @@
A
xref:../ugfun/ugfun.adoc#_ugfun_building-blocks_types-of-domain-objects_mixins[mixin]
acts like a trait or extension method, allowing one module to contribute
behaviour or derived state to another object.
-Syntactically, a mixin is defined using either the
xref:../rgant/rgant.adoc#_rgant_Mixin[`@Mixin`] annotation or using
xref:../rgant/rgant.adoc#_rgant_DomainObject_nature[`@DomainObject#nature()`]
attribute (specifying a nature of `Nature.MIXIN`).
+Syntactically, a mixin is defined using either the
xref:../rgant/rgant.adoc#_rgant-Mixin[`@Mixin`] annotation or using
xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature()`]
attribute (specifying a nature of `Nature.MIXIN`).
[source,java]
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins_inferred-name.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins_inferred-name.adoc
index b84c247..d0cc08f 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins_inferred-name.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_programming-model_mixins_inferred-name.adoc
@@ -33,7 +33,7 @@ public class DocumentHolder_documents {
----
-Alternatively, if the
xref:../rgant/rgant.adoc#_rgant_Mixin_method[`@Mixin#method()`] attribute is
specified, then this can nominate a different abbreviation.
+Alternatively, if the
xref:../rgant/rgant.adoc#_rgant-Mixin_method[`@Mixin#method()`] attribute is
specified, then this can nominate a different abbreviation.
The examples above (for
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_mixins_contributed-property[property],
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_mixins_contributed-collection[collection]
and
xref:../ugfun/ugfun.adoc#_ugfun_programming-model_mixins_contributed-action[action])
demonstrate this.
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
index 11e2b0c..9271fa6 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_eager-rendering.adoc
@@ -11,7 +11,7 @@ For the more commonly used collections we want to show the
table expanded:
image::{_imagesdir}programming-model/todoapp-Dashboard.png[width="px",link="{_imagesdir}programming-model/todoapp-Dashboard.png"]
-For this we annotate the collection using
xref:../rgant/rgant.adoc#_rgant_CollectionLayout_defaultView[`@CollectionLayout#defaultView()`];
for example
+For this we annotate the collection using
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_defaultView[`@CollectionLayout#defaultView()`];
for example
[source,java]
----
@@ -28,7 +28,7 @@ public Set<ToDoItem> getDependencies() {
[NOTE]
====
-The `defaultView()` attribute replaces the deprecated approach of using
xref:../rgant/rgant.adoc#_rgant_CollectionLayout_render[`@CollectionLayout#render()`]
eagerly.
+The `defaultView()` attribute replaces the deprecated approach of using
xref:../rgant/rgant.adoc#_rgant-CollectionLayout_render[`@CollectionLayout#render()`]
eagerly.
====
Alternatively, it can be specified the `Xxx.layout.xml` file:
diff --git
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
index 230a1f9..e821c7c 100644
---
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
+++
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_ui-hints_object-titles-and-icons.adoc
@@ -106,7 +106,7 @@ A variation on this approach also supports localized names;
see xref:../ugbtb/ug
A third alternative is to move the responsibility for deriving the title into
a separate subscriber object.
-In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`]
attribute to specify:
+In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`]
attribute to specify:
[source,java]
----
@@ -203,7 +203,7 @@ Otherwise it will just use "Order.png", as normal.
As for title, the determination of which image file to use for the icon can be
externalized into a UI event subscriber.
-In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_iconUiEvent[`@DomainObjectLayout#iconUiEvent()`]
attribute to specify.
+In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`@DomainObjectLayout#iconUiEvent()`]
attribute to specify.
For example
@@ -287,7 +287,7 @@ If non-null value is returned then the CSS class will be
rendered _in addition_
As for title and icon, the determination of which CSS class to render can be
externalized into a UI event subscriber.
-In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant_DomainObjectLayout_cssClassUiEvent[`@DomainObjectLayout#cssClassUiEvent()`]
attribute to specify.
+In the target object, we define an appropriate event type and use the
xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`@DomainObjectLayout#cssClassUiEvent()`]
attribute to specify.
For example
diff --git
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.10.0-to-1.11.0.adoc
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.10.0-to-1.11.0.adoc
index bc27945..4d50e96 100644
---
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.10.0-to-1.11.0.adoc
+++
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.10.0-to-1.11.0.adoc
@@ -67,7 +67,7 @@ However, if you are still using the older `isis.properties`
configuration file t
The new
xref:../guides/rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_RoutingService[`RoutingService`]
SPI service provides a plugin point to the
xref:../guides/ugvw/ugvw.adoc#[Wicket viewer] so that a different object than
that returned from an action invocation can be rendered.
-The framework provides a default implementation of this service that will -
instead of a void or a `null` result - render the home page (as per the
xref:../guides/rgant/rgant.adoc#_rgant_HomePage[`@HomePage`] annotation) if
there is one.
+The framework provides a default implementation of this service that will -
instead of a void or a `null` result - render the home page (as per the
xref:../guides/rgant/rgant.adoc#_rgant-HomePage[`@HomePage`] annotation) if
there is one.
This is therefore a subtle change in the UI.
If you wish to retain the original behaviour (to return the "no results" page
instead), then you should implement your own no-op implementation of this
service:
diff --git
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.12.0-to-1.13.0.adoc
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.12.0-to-1.13.0.adoc
index 75b32af..8f87ba6 100644
---
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.12.0-to-1.13.0.adoc
+++
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.12.0-to-1.13.0.adoc
@@ -61,12 +61,12 @@ There can be more than one implementation of this new SPI,
and a framework-provi
(`PublisherServiceLogging`) will log to a file. The (non-ASF)
link:http://platform.incode.org[Incode Platform^]'s publishmq module also
implements the new SPI.
The new service also supports the notion of published property edits; the new
-xref:../guides/rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`]
annotation attribute can be used to specify. The `
+xref:../guides/rgant/rgant.adoc#_rgant-Property_publishing[`@Property#publishing()`]
annotation attribute can be used to specify. The `
isis.services.publish.properties` configuration property can be used to
specify a fallback default for properties where
the attribute is not set explicitly.
-Conversely, neither the
xref:../guides/rgant/rgant.adoc#_rgant_Action_publishingPayloadFactory[`@Action#publishingPayloadFactory()`]
-nor the
xref:../guides/rgant/rgant.adoc#_rgant_DomainObject_publishingPayloadFactory[`@DomainObject#publishingPayloadFactory()`]
are
+Conversely, neither the
xref:../guides/rgant/rgant.adoc#_rgant-Action_publishingPayloadFactory[`@Action#publishingPayloadFactory()`]
+nor the
xref:../guides/rgant/rgant.adoc#_rgant-DomainObject_publishingPayloadFactory[`@DomainObject#publishingPayloadFactory()`]
are
supported by `PublisherService`; instead the consumers of the events are
expected to callback for any additional
information, eg using xref:../guides/ugvro/ugvro.adoc#[Resful Objects] viewer.
@@ -236,7 +236,7 @@ taking advantage of once you have upgraded.
* `@Nullable` annotation +
+
-The xref:../guides/rgant/rgant.adoc#_rgant_Nullable[`@Nullable`] annotation
can now be used to specify the optionality of properties
+The xref:../guides/rgant/rgant.adoc#_rgant-Nullable[`@Nullable`] annotation
can now be used to specify the optionality of properties
and parameters.
* `ActionDomainEvent` for mixins +
@@ -246,8 +246,8 @@ mixin action. This is now possible, through the
xref:../guides/rgcms/rgcms.adoc
* `Blob` and `Clob` file types +
+
-The
xref:../guides/rgant/rgant.adoc#_rgant_Property_fileAccept[`@Property#fileAccept()`]
and
-xref:../guides/rgant/rgant.adoc#_rgant_Parameter_fileAccept[`@Parameter#fileAccept()`]
annotation attributes can be used to hint at
+The
xref:../guides/rgant/rgant.adoc#_rgant-Property_fileAccept[`@Property#fileAccept()`]
and
+xref:../guides/rgant/rgant.adoc#_rgant-Parameter-fileAccept[`@Parameter#fileAccept()`]
annotation attributes can be used to hint at
the file type to upload for a blob or clob.
* Live reloading +
diff --git
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.14.0-to-1.15.0.adoc
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.14.0-to-1.15.0.adoc
index 9d0f4f0..53ea7f9 100644
---
a/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.14.0-to-1.15.0.adoc
+++
b/adocs/documentation/src/main/asciidoc/migration-notes/_migration-notes_1.14.0-to-1.15.0.adoc
@@ -67,7 +67,7 @@ Domain services fall into three categories:
As described
xref:../guides/ugbtb/ugbtb.adoc#_ugbtb_hints-and-tips_replacing-default-service-implementations[here],
it is possible to override framework services so that the framework uses the
replacement implementation.
-Previously this required explicitly setting either
xref:../guides/rgant/rgant.adoc#_rgant_DomainService_menuOrder[`@DomainService#menuOrder()`]
or
xref:../guides/rgant/rgant.adoc#_rgant_DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`].
+Previously this required explicitly setting either
xref:../guides/rgant/rgant.adoc#_rgant-DomainService_menuOrder[`@DomainService#menuOrder()`]
or
xref:../guides/rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`].
In 1.15.0, the default value for `menuOrder` has been set to a value lower
than that of the framework-provided implementations, and so will a custom
implementation will always take precedence over the framework implementations
without having to remember to also set `menuOrder`.
--
To stop receiving notification emails like this one, please contact
danhayw...@apache.org.
