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 2019/09/24 23:31:31 UTC
[isis] 01/07: ISIS-2062: inlines partials for rg:cms (methods and
schema)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch v2
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 62ad43d75a0eb8fe4cbd17b16722ccc59cf999f6
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Sep 24 22:24:02 2019 +0100
ISIS-2062: inlines partials for rg:cms (methods and schema)
---
.../components/toc/modules/ROOT/_attributes.adoc | 1 +
.../pages/what-is-apache-isis/screencasts.adoc | 22 +++++-----
.../{pages/_partials => partials}/_attributes.adoc | 0
.../_powered-by_commapp.adoc | 0
.../_powered-by_contactapp.adoc | 0
.../_partials => partials}/_powered-by_cqnz.adoc | 0
.../_powered-by_estatio.adoc | 0
.../_powered-by_gesconsultor-grc.adoc | 0
.../_powered-by_transport-planner.adoc | 0
.../_screencasts-playlists.adoc | 0
.../modules/ant/pages/ActionLayout/redirect.adoc | 2 +-
core/_adoc-rg/modules/ant/pages/Discriminator.adoc | 2 +-
.../pages/DomainObject/autoCompleteRepository.adoc | 2 +-
.../modules/ant/pages/DomainObject/bounding.adoc | 2 +-
.../modules/ant/pages/DomainObject/objectType.adoc | 2 +-
.../ant/pages/DomainObjectLayout/cssClassFa.adoc | 2 +-
.../pages/DomainObjectLayout/cssClassUiEvent.adoc | 2 +-
.../ant/pages/DomainObjectLayout/iconUiEvent.adoc | 2 +-
.../pages/DomainObjectLayout/layoutUiEvent.adoc | 2 +-
.../ant/pages/DomainObjectLayout/titleUiEvent.adoc | 2 +-
.../ant/pages/DomainService/objectType.adoc | 4 +-
core/_adoc-rg/modules/ant/pages/MinLength.adoc | 2 +-
.../modules/ant/pages/PersistenceCapable.adoc | 2 +-
.../modules/ant/pages/ViewModel/objectType.adoc | 2 +-
.../ant/pages/ViewModelLayout/iconUiEvent.adoc | 2 +-
.../_adoc-rg/modules/ant/pages/XmlRootElement.adoc | 2 +-
.../modules/cfg/pages/configuring-core.adoc | 2 +-
core/_adoc-rg/modules/cms/nav.adoc | 32 --------------
core/_adoc-rg/modules/cms/pages/classes.adoc | 15 +++++++
.../pages/classes/AppManifest-bootstrapping.adoc | 3 +-
.../pages/classes/AppManifest2-bootstrapping.adoc | 10 ++---
.../modules/cms/pages/classes/contributee.adoc | 1 +
.../classes/contributee/HasTransactionId.adoc | 3 +-
.../cms/pages/classes/contributee/HasUserName.adoc | 1 +
.../modules/cms/pages/classes/domainevent.adoc | 9 ++--
.../classes/domainevent/AbstractDomainEvent.adoc | 7 +--
.../classes/domainevent/ActionDomainEvent.adoc | 3 +-
.../classes/domainevent/CollectionDomainEvent.adoc | 3 +-
.../classes/domainevent/PropertyDomainEvent.adoc | 3 +-
core/_adoc-rg/modules/cms/pages/classes/i18n.adoc | 1 +
.../cms/pages/classes/i18n/TranslatableString.adoc | 1 +
.../_adoc-rg/modules/cms/pages/classes/layout.adoc | 1 +
.../modules/cms/pages/classes/lifecycleevent.adoc | 17 ++++----
.../lifecycleevent/AbstractLifecycleEvent.adoc | 15 ++++---
.../classes/lifecycleevent/ObjectCreatedEvent.adoc | 3 +-
.../classes/lifecycleevent/ObjectLoadedEvent.adoc | 3 +-
.../lifecycleevent/ObjectPersistedEvent.adoc | 3 +-
.../lifecycleevent/ObjectPersistingEvent.adoc | 3 +-
.../lifecycleevent/ObjectRemovingEvent.adoc | 3 +-
.../classes/lifecycleevent/ObjectUpdatedEvent.adoc | 3 +-
.../lifecycleevent/ObjectUpdatingEvent.adoc | 3 +-
.../modules/cms/pages/classes/menubars.adoc | 1 +
.../_adoc-rg/modules/cms/pages/classes/mixins.adoc | 1 +
.../modules/cms/pages/classes/mixins/Dto.adoc | 7 +--
.../modules/cms/pages/classes/mixins/Object.adoc | 3 +-
.../cms/pages/classes/mixins/Persistable.adoc | 5 ++-
core/_adoc-rg/modules/cms/pages/classes/roles.adoc | 1 +
.../cms/pages/classes/roles/HoldsUpdatedAt.adoc | 3 +-
.../cms/pages/classes/roles/HoldsUpdatedBy.adoc | 3 +-
.../cms/pages/classes/roles/Timestampable.adoc | 5 ++-
core/_adoc-rg/modules/cms/pages/classes/spec.adoc | 3 +-
core/_adoc-rg/modules/cms/pages/classes/super.adoc | 11 ++---
.../cms/pages/classes/super/AbstractService.adoc | 1 +
.../pages/classes/super/AbstractSubscriber.adoc | 1 +
.../cms/pages/classes/super/AbstractViewModel.adoc | 3 +-
.../cms/pages/classes/super/FixtureScript.adoc | 1 +
.../cms/pages/classes/super/FixtureScripts.adoc | 3 +-
.../modules/cms/pages/classes/uievent.adoc | 13 +++---
.../cms/pages/classes/uievent/CssClassUiEvent.adoc | 3 +-
.../cms/pages/classes/uievent/IconUiEvent.adoc | 3 +-
.../cms/pages/classes/uievent/TitleUiEvent.adoc | 3 +-
.../modules/cms/pages/classes/utility.adoc | 1 +
.../modules/cms/pages/classes/utility/Enums.adoc | 1 +
.../cms/pages/classes/utility/ObjectContracts.adoc | 1 +
.../modules/cms/pages/classes/utility/Reasons.adoc | 1 +
.../cms/pages/classes/utility/TitleBuffer.adoc | 3 +-
.../modules/cms/pages/classes/value-types.adoc | 1 +
.../cms/pages/classes/value-types/Blob.adoc | 3 +-
.../cms/pages/classes/value-types/Clob.adoc | 3 +-
.../cms/pages/classes/value-types/Color.adoc | 1 +
.../cms/pages/classes/value-types/Markup.adoc | 1 +
.../cms/pages/classes/value-types/Money.adoc | 1 +
.../cms/pages/classes/value-types/Password.adoc | 1 +
core/_adoc-rg/modules/cms/pages/methods.adoc | 3 ++
.../modules/cms/pages/methods/lifecycle.adoc | 18 ++++----
.../cms/pages/methods/lifecycle/created.adoc | 2 +-
.../cms/pages/methods/lifecycle/loaded.adoc | 2 +-
.../cms/pages/methods/lifecycle/persisted.adoc | 4 +-
.../cms/pages/methods/lifecycle/persisting.adoc | 4 +-
.../cms/pages/methods/lifecycle/removed.adoc | 4 +-
.../cms/pages/methods/lifecycle/removing.adoc | 4 +-
.../cms/pages/methods/lifecycle/updated.adoc | 4 +-
.../cms/pages/methods/lifecycle/updating.adoc | 4 +-
.../modules/cms/pages/methods/prefixes.adoc | 50 +++++++++++-----------
.../modules/cms/pages/methods/prefixes/addTo.adoc | 2 +-
.../cms/pages/methods/prefixes/autoComplete.adoc | 2 +-
.../cms/pages/methods/prefixes/choices.adoc | 2 +-
.../modules/cms/pages/methods/prefixes/clear.adoc | 2 +-
.../cms/pages/methods/prefixes/default.adoc | 2 +-
.../modules/cms/pages/methods/prefixes/get.adoc | 2 +-
.../modules/cms/pages/methods/prefixes/hide.adoc | 2 +-
.../modules/cms/pages/methods/prefixes/modify.adoc | 2 +-
.../cms/pages/methods/prefixes/removeFrom.adoc | 2 +-
.../modules/cms/pages/methods/prefixes/set.adoc | 2 +-
.../cms/pages/methods/prefixes/validateAddTo.adoc | 2 +-
.../pages/methods/prefixes/validateRemoveFrom.adoc | 2 +-
.../modules/cms/pages/methods/reserved.adoc | 16 +++----
.../cms/pages/methods/reserved/cssClass.adoc | 6 +--
.../cms/pages/methods/reserved/disable.adoc | 6 +--
.../modules/cms/pages/methods/reserved/getId.adoc | 4 +-
.../modules/cms/pages/methods/reserved/hide.adoc | 8 ++--
.../cms/pages/methods/reserved/iconName.adoc | 8 ++--
.../modules/cms/pages/methods/reserved/layout.adoc | 6 +--
.../modules/cms/pages/methods/reserved/title.adoc | 8 ++--
.../cms/pages/methods/reserved/validate.adoc | 2 +-
core/_adoc-rg/modules/cms/pages/schema.adoc | 17 +++++---
core/_adoc-rg/modules/cms/pages/schema/aim.adoc | 6 +--
core/_adoc-rg/modules/cms/pages/schema/chg.adoc | 8 ++--
core/_adoc-rg/modules/cms/pages/schema/cmd.adoc | 12 +++---
core/_adoc-rg/modules/cms/pages/schema/common.adoc | 12 +++---
core/_adoc-rg/modules/cms/pages/schema/ixn.adoc | 24 +++++------
core/_adoc-rg/modules/cms/pages/schema/mml.adoc | 2 +-
.../CommandDtoServiceInternal.adoc | 6 +--
.../InteractionDtoServiceInternal.adoc | 6 +--
.../CommandExecutorService.adoc | 2 +-
.../application-layer-api/DtoMappingHelper.adoc | 2 +-
.../application-layer-api/InteractionContext.adoc | 2 +-
.../application-layer-api/WrapperFactory.adoc | 4 +-
.../BackgroundCommandService.adoc | 2 +-
core/_adoc-rg/modules/svc/pages/intro.adoc | 2 +-
.../persistence-layer-spi/PublisherService.adoc | 6 +--
.../ContentMappingService.adoc | 2 +-
.../deployment/externalized-configuration.adoc | 1 +
.../btb/pages/hints-and-tips/are-you-sure.adoc | 2 +-
.../btb/pages/hints-and-tips/persisted-title.adoc | 2 +-
.../btb/pages/hints-and-tips/pushing-changes.adoc | 4 +-
core/_adoc-ug/modules/btb/pages/i18n.adoc | 2 +-
.../fun/pages/building-blocks/identifiers/oid.adoc | 2 +-
.../fun/pages/business-rules/side-effects.adoc | 2 +-
.../fun/pages/business-rules/usability.adoc | 2 +-
.../modules/fun/pages/business-rules/validity.adoc | 2 +-
.../fun/pages/business-rules/visibility.adoc | 2 +-
.../modules/fun/pages/drop-downs-and-defaults.adoc | 6 +--
.../fun/pages/programming-model/actions.adoc | 2 +-
.../view-models/dto/dto-consumers.adoc | 2 +-
.../jaxb/referencing-domain-entities.adoc | 2 +-
.../pages/ui-hints/object-titles-and-icons.adoc | 8 ++--
.../testsupport/_adoc/modules/mvn/pages/intro.adoc | 2 +-
core/testsupport/_adoc/modules/mvn/pages/xsd.adoc | 8 ++--
.../_adoc/modules/ROOT/pages/layout-resources.adoc | 2 +-
.../modules/ROOT/pages/layout/file-based.adoc | 2 +-
151 files changed, 350 insertions(+), 304 deletions(-)
diff --git a/antora/components/toc/modules/ROOT/_attributes.adoc b/antora/components/toc/modules/ROOT/_attributes.adoc
index 787e5c4..5183e0b 100644
--- a/antora/components/toc/modules/ROOT/_attributes.adoc
+++ b/antora/components/toc/modules/ROOT/_attributes.adoc
@@ -1,6 +1,7 @@
ifndef::env-site,env-github[]
:attachmentsdir: {moduledir}/assets/attachments
:examplesdir: {moduledir}/examples
+:partialsdir: {moduledir}/partials
:imagesdir: {moduledir}/assets/images
:partialsdir: {moduledir}/pages/_partials
endif::[]
diff --git a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
index 836f7e1..afe91e7 100644
--- a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
+++ b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
@@ -103,7 +103,7 @@ Writing end-to-end xref:testing:ROOT:integ-test-support.adoc[integration tests]
-11+| [big]#*Swagger UI*#
+12+| [big]#*Swagger UI*#
include::partial$_screencasts-playlists.adoc[]
@@ -159,7 +159,7 @@ include::partial$_screencasts-playlists.adoc[]
|link:https://www.youtube.com/watch?v=CwM430UH5WE[014^] +
-Using the xref:rg:cms:methods/reserved.adoc#title[`title()`], xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] and xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`] so that end-users can distinguish domain objects within the UI.
+Using the xref:rg:cms:methods.adoc#title[`title()`], xref:rg:cms:methods.adoc#iconName[`iconName()`] and xref:rg:cms:methods.adoc#cssClass[`cssClass()`] so that end-users can distinguish domain objects within the UI.
|x||x||||||x||
@@ -252,7 +252,7 @@ Shows how to refactor a domain object to move (derived) collections out of the d
|link:https://www.youtube.com/watch?v=-AQJb9GtIqI[024^] +
-Using a domain event xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] to xref:ug:fun:building-blocks.adoc#domain-events[decouple] and abstract business rules (xref:rg:cms:methods/prefixes.adoc#validate[validation]).
+Using a domain event xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] to xref:ug:fun:building-blocks.adoc#domain-events[decouple] and abstract business rules (xref:rg:cms:methods.adoc#validate[validation]).
||||||x|||||
@@ -271,7 +271,7 @@ Using a domain event xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscribe
|link:https://www.youtube.com/watch?v=qj4bMkQRBUY[026^] +
-Using the xref:rg:ant:Title.adoc[`@Title`] annotation (instead of the xref:rg:cms:methods/reserved.adoc#title[`title()`] reserved method) to obtain the title of a domain object, so that the end-user can distinguish one object from another.
+Using the xref:rg:ant:Title.adoc[`@Title`] annotation (instead of the xref:rg:cms:methods.adoc#title[`title()`] reserved method) to obtain the title of a domain object, so that the end-user can distinguish one object from another.
|x||||||||x||
@@ -322,7 +322,7 @@ include::partial$_screencasts-playlists.adoc[]
|link:https://www.youtube.com/watch?v=ORoEYlg6XFM[030^] +
-How to validate action parameters using a supporting xref:rg:cms:methods/prefixes.adoc#validate[`validateNXxx()`] method.
+How to validate action parameters using a supporting xref:rg:cms:methods.adoc#validate[`validateNXxx()`] method.
|x||||||||x||
@@ -355,19 +355,19 @@ include::partial$_screencasts-playlists.adoc[]
|link:https://www.youtube.com/watch?v=cQ06PoMNDPw[033^] +
-How to provide a set of xref:rg:cms:methods/prefixes.adoc#choices[choices] (a drop-down list) when editing a property.
+How to provide a set of xref:rg:cms:methods.adoc#choices[choices] (a drop-down list) when editing a property.
|x||||||||x||
|link:https://www.youtube.com/watch?v=afEnYKljBQs[034^] +
-How to provide a set of xref:rg:cms:methods/prefixes.adoc#choices[choices] (a drop-down list) when invoking an action.
+How to provide a set of xref:rg:cms:methods.adoc#choices[choices] (a drop-down list) when invoking an action.
|||||||||x||
|link:https://www.youtube.com/watch?v=fKo6aTPK-gk[035^] +
-How to use the xref:rg:cms:methods/prefixes.adoc#choices[choices] supporting methods as a source for default values within a xref:testing:ROOT:fixture-scripts.adoc[fixture script].
+How to use the xref:rg:cms:methods.adoc#choices[choices] supporting methods as a source for default values within a xref:testing:ROOT:fixture-scripts.adoc[fixture script].
||x|||||||x||
@@ -446,7 +446,7 @@ include::partial$_screencasts-playlists.adoc[]
|link:https://www.youtube.com/watch?v=Rt4JoV4ssVY[043^] +
-How to use the supporting xref:rg:cms:methods/prefixes.adoc#default[`defaultXxx(...)`] supporting method to provide a default argument value for action parameters.
+How to use the supporting xref:rg:cms:methods.adoc#default[`defaultXxx(...)`] supporting method to provide a default argument value for action parameters.
|x||||||||x||
@@ -456,12 +456,12 @@ How to use xref:rg:ant:DomainObject.adoc#bounding[`@DomainObject#bounding()`] so
|link:https://www.youtube.com/watch?v=0ro_YhXOpJU[045^] +
-How to use the xref:rg:cms:methods/prefixes.adoc#choices[`choicesXxx(...)`] supporting method to provide a drop-down list for parameters to actions that are for reference types (domain entities or view models).
+How to use the xref:rg:cms:methods.adoc#choices[`choicesXxx(...)`] supporting method to provide a drop-down list for parameters to actions that are for reference types (domain entities or view models).
|||||||||x||
|link:https://www.youtube.com/watch?v=K36IJQ_hDfs[046^] +
-How to use the xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoCompleteXxx(...)`] supporting method to provide a drop-down list for parameters to actions that are for reference types (domain entities or view models).
+How to use the xref:rg:cms:methods.adoc#autoComplete[`autoCompleteXxx(...)`] supporting method to provide a drop-down list for parameters to actions that are for reference types (domain entities or view models).
|||||||||x||
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_attributes.adoc b/antora/components/toc/modules/ROOT/partials/_attributes.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_attributes.adoc
rename to antora/components/toc/modules/ROOT/partials/_attributes.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_commapp.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_commapp.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_commapp.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_commapp.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_contactapp.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_contactapp.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_contactapp.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_contactapp.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_cqnz.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_cqnz.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_cqnz.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_cqnz.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_estatio.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_estatio.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_estatio.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_estatio.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_gesconsultor-grc.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_gesconsultor-grc.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_gesconsultor-grc.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_gesconsultor-grc.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_powered-by_transport-planner.adoc b/antora/components/toc/modules/ROOT/partials/_powered-by_transport-planner.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_powered-by_transport-planner.adoc
rename to antora/components/toc/modules/ROOT/partials/_powered-by_transport-planner.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/_partials/_screencasts-playlists.adoc b/antora/components/toc/modules/ROOT/partials/_screencasts-playlists.adoc
similarity index 100%
rename from antora/components/toc/modules/ROOT/pages/_partials/_screencasts-playlists.adoc
rename to antora/components/toc/modules/ROOT/partials/_screencasts-playlists.adoc
diff --git a/core/_adoc-rg/modules/ant/pages/ActionLayout/redirect.adoc b/core/_adoc-rg/modules/ant/pages/ActionLayout/redirect.adoc
index 1a09a1a..916fbf2 100644
--- a/core/_adoc-rg/modules/ant/pages/ActionLayout/redirect.adoc
+++ b/core/_adoc-rg/modules/ant/pages/ActionLayout/redirect.adoc
@@ -23,7 +23,7 @@ Any properties with xref:rg:ant:PropertyLayout.adoc#unchanging[`@PropertyLayout#
* if set to `AS_CONFIGURED`, then the default behaviour is as specified by the `isis.viewer.wicket.redirectEvenIfSameObject` xref:vw:ROOT:configuration-properties.adoc[configuration property]).
-One use case for choosing `EVEN_IF_SAME` is if the action "returning this" is intended in some way to require that the object use a different layout, as per multiple layout support, as specified using the xref:rg:cms:methods/reserved.adoc#layout[`layout()`] method.
+One use case for choosing `EVEN_IF_SAME` is if the action "returning this" is intended in some way to require that the object use a different layout, as per multiple layout support, as specified using the xref:rg:cms:methods.adoc#layout[`layout()`] method.
For example:
diff --git a/core/_adoc-rg/modules/ant/pages/Discriminator.adoc b/core/_adoc-rg/modules/ant/pages/Discriminator.adoc
index 832532c..85fcd238 100644
--- a/core/_adoc-rg/modules/ant/pages/Discriminator.adoc
+++ b/core/_adoc-rg/modules/ant/pages/Discriminator.adoc
@@ -21,7 +21,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
** and thus in the "table-of-two-halves" pattern, as per the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s poly module
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (in general and in particular if xref:vw:ROOT:features/hints-and-copy-url.adoc[copying URLs])
* in XML snapshots generated by the xref:rg:svc:integration-api/XmlSnapshotService.adoc[`XmlSnapshotService`]
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObject/autoCompleteRepository.adoc b/core/_adoc-rg/modules/ant/pages/DomainObject/autoCompleteRepository.adoc
index 4790a9a..b5ab69a 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObject/autoCompleteRepository.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObject/autoCompleteRepository.adoc
@@ -14,7 +14,7 @@ Or it could search for a country based on its ISO-3 code or user-friendly name.
[TIP]
====
-If you require additional control - for example restricting the returned results based on the object being interacted with - then use the xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`] supporting method instead.
+If you require additional control - for example restricting the returned results based on the object being interacted with - then use the xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`] supporting method instead.
====
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObject/bounding.adoc b/core/_adoc-rg/modules/ant/pages/DomainObject/bounding.adoc
index 37412e8..90fc016 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObject/bounding.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObject/bounding.adoc
@@ -32,7 +32,7 @@ public class Currency {
[TIP]
====
There is nothing to prevent you from using this attribute for regular mutable entities, and indeed this is sometimes worth doing during early prototyping.
-However, if there is no realistic upper bound to the number of instances of an entity that might be created, generally you should use xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`] supporting method or the xref:rg:ant:DomainObject.adoc#autoCompleteRepository[`@DomainObject#autoCompleteRepository()`] attribute instead.
+However, if there is no realistic upper bound to the number of instances of an entity that might be created, generally you should use xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`] supporting method or the xref:rg:ant:DomainObject.adoc#autoCompleteRepository[`@DomainObject#autoCompleteRepository()`] attribute instead.
====
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObject/objectType.adoc b/core/_adoc-rg/modules/ant/pages/DomainObject/objectType.adoc
index de8f9a4..a4e6a02 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObject/objectType.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObject/objectType.adoc
@@ -13,7 +13,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
** and thus in the "table-of-two-halves" pattern, as per the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s poly module
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (in general and in particular if xref:vw:ROOT:features/hints-and-copy-url.adoc[copying URLs])
* in XML snapshots generated by the xref:rg:svc:integration-api/XmlSnapshotService.adoc[`XmlSnapshotService`]
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassFa.adoc b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassFa.adoc
index a6d7d37..c81ba23 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassFa.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassFa.adoc
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
The `cssClassFa()` attribute is used to specify the name of a link:http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icon] name, to be rendered as the domain object's icon.
-If necessary the icon specified can be overridden by a particular object instance using the xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] method.
+If necessary the icon specified can be overridden by a particular object instance using the xref:rg:cms:methods.adoc#iconName[`iconName()`] method.
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassUiEvent.adoc b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassUiEvent.adoc
index c387962..93039cc 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassUiEvent.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/cssClassUiEvent.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
Whenever a domain object is to be rendered, the framework fires off an CSS class UI event to obtain a CSS class to use in any wrapping ``<div>``s and ``<span>``s that render the domain object.
-This is as an alternative to implementing xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`] reserved method.
+This is as an alternative to implementing xref:rg:cms:methods.adoc#cssClass[`cssClass()`] reserved method.
(If `cssClass()` is present, then it will take precedence).
Subscribers subscribe through the xref:rg:svc:core-domain-api/EventBusService.adoc[`EventBusService`] and can use obtain a reference to the domain object from the event.
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/iconUiEvent.adoc b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/iconUiEvent.adoc
index 8886281..8035739 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/iconUiEvent.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/iconUiEvent.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
Whenever a domain object is to be rendered, the framework fires off an icon UI event to obtain an icon (name) for the object (if possible).
-This is as an alternative to implementing xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] reserved method.
+This is as an alternative to implementing xref:rg:cms:methods.adoc#iconName[`iconName()`] reserved method.
(If `iconName()` is present, then it will take precedence).
Subscribers subscribe through the xref:rg:svc:core-domain-api/EventBusService.adoc[`EventBusService`] and can use obtain a reference to the domain object from the event.
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/layoutUiEvent.adoc b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/layoutUiEvent.adoc
index 0593a6b..4287cd7 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/layoutUiEvent.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/layoutUiEvent.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
Whenever a domain object is to be rendered, the framework fires off an layout UI event to obtain an alternative layout name with which to render the domain object.
-This is as an alternative to implementing xref:rg:cms:methods/reserved.adoc#layout[`layout()`] reserved method.
+This is as an alternative to implementing xref:rg:cms:methods.adoc#layout[`layout()`] reserved method.
(If `layout()` is present, then it will take precedence).
Subscribers subscribe through the xref:rg:svc:core-domain-api/EventBusService.adoc[`EventBusService`] and can use obtain a reference to the domain object from the event.
diff --git a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/titleUiEvent.adoc b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/titleUiEvent.adoc
index f1dc088..6264bd4 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/titleUiEvent.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainObjectLayout/titleUiEvent.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
Whenever a domain object is to be rendered, the framework fires off a title UI event to obtain a title for the object.
-This is as an alternative to implementing xref:rg:cms:methods/reserved.adoc#title[`title()`] reserved method, or using the xref:rg:ant:Title.adoc[`@Title`] annotation, within the class itself.
+This is as an alternative to implementing xref:rg:cms:methods.adoc#title[`title()`] reserved method, or using the xref:rg:ant:Title.adoc[`@Title`] annotation, within the class itself.
(If either `title()` or `@Title` are present, then they will take precedence).
Subscribers subscribe through the xref:rg:svc:core-domain-api/EventBusService.adoc[`EventBusService`] and can
diff --git a/core/_adoc-rg/modules/ant/pages/DomainService/objectType.adoc b/core/_adoc-rg/modules/ant/pages/DomainService/objectType.adoc
index 658d930..0fcefcd 100644
--- a/core/_adoc-rg/modules/ant/pages/DomainService/objectType.adoc
+++ b/core/_adoc-rg/modules/ant/pages/DomainService/objectType.adoc
@@ -12,7 +12,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (specifically, for bookmarked actions)
@@ -39,7 +39,7 @@ public class OrderMenu {
The rules of precedence are:
1. `@DomainService#objectType`
-2. xref:rg:cms:methods/reserved.adoc#getId[`getId()`]
+2. xref:rg:cms:methods.adoc#getId[`getId()`]
3. The fully qualified class name.
diff --git a/core/_adoc-rg/modules/ant/pages/MinLength.adoc b/core/_adoc-rg/modules/ant/pages/MinLength.adoc
index 26e39e9..7c27fce 100644
--- a/core/_adoc-rg/modules/ant/pages/MinLength.adoc
+++ b/core/_adoc-rg/modules/ant/pages/MinLength.adoc
@@ -3,7 +3,7 @@
include::_attributes.adoc[]
-The `@MinLength` annotation is used to specify the minimum number of characters in a search of an xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`] supporting method.
+The `@MinLength` annotation is used to specify the minimum number of characters in a search of an xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`] supporting method.
For example:
diff --git a/core/_adoc-rg/modules/ant/pages/PersistenceCapable.adoc b/core/_adoc-rg/modules/ant/pages/PersistenceCapable.adoc
index 11bcc62..099dc6a 100644
--- a/core/_adoc-rg/modules/ant/pages/PersistenceCapable.adoc
+++ b/core/_adoc-rg/modules/ant/pages/PersistenceCapable.adoc
@@ -22,7 +22,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
** and thus in the "table-of-two-halves" pattern, as per the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s poly module
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (in general and in particular if xref:vw:ROOT:features/hints-and-copy-url.adoc[copying URLs])
* in XML snapshots generated by the xref:rg:svc:integration-api/XmlSnapshotService.adoc[`XmlSnapshotService`]
diff --git a/core/_adoc-rg/modules/ant/pages/ViewModel/objectType.adoc b/core/_adoc-rg/modules/ant/pages/ViewModel/objectType.adoc
index 2b1dbba..f817a5e 100644
--- a/core/_adoc-rg/modules/ant/pages/ViewModel/objectType.adoc
+++ b/core/_adoc-rg/modules/ant/pages/ViewModel/objectType.adoc
@@ -13,7 +13,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
** and thus in the "table-of-two-halves" pattern, as per the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s poly module
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (in general and in particular if xref:vw:ROOT:features/hints-and-copy-url.adoc[copying URLs])
* in XML snapshots generated by the xref:rg:svc:integration-api/XmlSnapshotService.adoc[`XmlSnapshotService`]
diff --git a/core/_adoc-rg/modules/ant/pages/ViewModelLayout/iconUiEvent.adoc b/core/_adoc-rg/modules/ant/pages/ViewModelLayout/iconUiEvent.adoc
index 7052393..0daeee9 100644
--- a/core/_adoc-rg/modules/ant/pages/ViewModelLayout/iconUiEvent.adoc
+++ b/core/_adoc-rg/modules/ant/pages/ViewModelLayout/iconUiEvent.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
Whenever a view model is to be rendered, the framework fires off an icon UI event to obtain an icon (name) for the object (if possible).
-This is as an alternative to implementing xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] reserved method.
+This is as an alternative to implementing xref:rg:cms:methods.adoc#iconName[`iconName()`] reserved method.
(If `iconName()` is present, then it will take precedence).
This attribute is the same as xref:rg:ant:DomainObjectLayout.adoc#iconUiEvent[`@DomainObjectLayout#iconUiEvent()`], but for view models instead of entities.
diff --git a/core/_adoc-rg/modules/ant/pages/XmlRootElement.adoc b/core/_adoc-rg/modules/ant/pages/XmlRootElement.adoc
index 71c6f35..cc7adc8 100644
--- a/core/_adoc-rg/modules/ant/pages/XmlRootElement.adoc
+++ b/core/_adoc-rg/modules/ant/pages/XmlRootElement.adoc
@@ -23,7 +23,7 @@ In contrast, if the `@ViewModel` annotation is used then only the state of the p
If using `ViewModel` interface then arbitrary state (including that of collections), however the programmer must write all the code by hand
The main disadvantages of using JAXB-annotated view models is that any referenced persistent entity must be annotated with the xref:rg:ant:XmlJavaTypeAdapter.adoc[`@XmlJavaTypeAdapter`], using the framework-provided `PersistentEntityAdapter`.
-This adapter converts any references to such domain entities using the `oidDto` complex type (as defined by the Apache Isis xref:rg:cms:schema/common.adoc[common schema]): the object's type and its identifier.
+This adapter converts any references to such domain entities using the `oidDto` complex type (as defined by the Apache Isis xref:rg:cms:schema.adoc#common[common schema]): the object's type and its identifier.
[TIP]
====
diff --git a/core/_adoc-rg/modules/cfg/pages/configuring-core.adoc b/core/_adoc-rg/modules/cfg/pages/configuring-core.adoc
index 7d9ad87..aa7d332 100644
--- a/core/_adoc-rg/modules/cfg/pages/configuring-core.adoc
+++ b/core/_adoc-rg/modules/cfg/pages/configuring-core.adoc
@@ -511,7 +511,7 @@ This is by way of possibly deprecating and eventually moving contributed service
`noParamsOnly`
|`true`,`false` +
(`false`)
-| When searching for xref:rg:cms:methods/prefixes.adoc#disable[`disableXxx()`] or xref:rg:cms:methods/prefixes.adoc#hide[`hideXxx()`] methods, whether to search only for the no-param version (or also for supporting methods that match the parameter types of the action). +
+| When searching for xref:rg:cms:methods.adoc#disable[`disableXxx()`] or xref:rg:cms:methods.adoc#hide[`hideXxx()`] methods, whether to search only for the no-param version (or also for supporting methods that match the parameter types of the action). +
If enabled then will not search for supporting methods with the exact set of arguments as the method it was supporting (and any supporting methods that have additional parameters will be treated as invalid).
Note that this in effect means that xref:ug:fun:building-blocks.adoc#mixins[mixins] must be used instead of xref:ug:fun:programming-model.adoc#contributions[contributed services].
diff --git a/core/_adoc-rg/modules/cms/nav.adoc b/core/_adoc-rg/modules/cms/nav.adoc
index 748e674..981dc9e 100644
--- a/core/_adoc-rg/modules/cms/nav.adoc
+++ b/core/_adoc-rg/modules/cms/nav.adoc
@@ -1,39 +1,7 @@
* xref:about.adoc[Classes, Methods & Schema]
** xref:methods.adoc[Methods]
-
-*** xref:methods/prefixes.adoc[Prefixes]
-*** xref:methods/reserved.adoc[Reserved]
-*** xref:methods/lifecycle.adoc[Lifecycle]
-
-
** xref:classes.adoc[Classes]
-
-*** xref:classes/AppManifest-bootstrapping.adoc[AppManifest Bootstrapping]
-*** xref:classes/AppManifest2-bootstrapping.adoc[AppManifest2 Bootstrapping]
-*** xref:classes/super.adoc[Super Classes]
-*** xref:classes/domainevent.adoc[Domain Event Classes]
-*** xref:classes/uievent.adoc[UI Event Classes]
-*** xref:classes/lifecycleevent.adoc[Lifecycle Event Classes]
-*** xref:classes/value-types.adoc[Value Types]
-*** xref:classes/utility.adoc[Utility Classes]
-*** xref:classes/spec.adoc[Specification Classes]
-*** xref:classes/i18n.adoc[i18n Classes]
-*** xref:classes/contributee.adoc[Contributee]
-*** xref:classes/roles.adoc[Roles]
-*** xref:classes/mixins.adoc[Mixins]
-*** xref:classes/layout.adoc[(Object) Layout]
-*** xref:classes/menubars.adoc[Menubars]
-
-
-
** xref:schema.adoc[Schema]
-//*** xref:schema/aim.adoc[aim: ActionInvocationMemento] // replaced in 1.13.0
-*** xref:schema/mml.adoc[mml: Metamodel]
-*** xref:schema/cmd.adoc[cmd: Command]
-*** xref:schema/ixn.adoc[ixn: Interaction]
-*** xref:schema/chg.adoc[chg: Change]
-*** xref:schema/common.adoc[Common]
-
diff --git a/core/_adoc-rg/modules/cms/pages/classes.adoc b/core/_adoc-rg/modules/cms/pages/classes.adoc
index 7af6b5f..3e7ae32 100644
--- a/core/_adoc-rg/modules/cms/pages/classes.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes.adoc
@@ -8,3 +8,18 @@ This chapter describes the usage of various classes and interfaces that are not
+include::classes/AppManifest-bootstrapping.adoc[leveloffset=+1]
+include::classes/AppManifest2-bootstrapping.adoc[leveloffset=+1]
+include::classes/super.adoc[leveloffset=+1]
+include::classes/domainevent.adoc[leveloffset=+1]
+include::classes/uievent.adoc[leveloffset=+1]
+include::classes/lifecycleevent.adoc[leveloffset=+1]
+include::classes/value-types.adoc[leveloffset=+1]
+include::classes/utility.adoc[leveloffset=+1]
+include::classes/spec.adoc[leveloffset=+1]
+include::classes/i18n.adoc[leveloffset=+1]
+include::classes/contributee.adoc[leveloffset=+1]
+include::classes/roles.adoc[leveloffset=+1]
+include::classes/mixins.adoc[leveloffset=+1]
+include::classes/layout.adoc[leveloffset=+1]
+include::classes/menubars.adoc[leveloffset=+1]
diff --git a/core/_adoc-rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc b/core/_adoc-rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
index 69e51d1..f4cc797 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
@@ -1,6 +1,5 @@
[[AppManifest-bootstrapping]]
= `AppManifest` (bootstrapping)
-
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
@@ -186,7 +185,7 @@ public Map<String, String> getConfigurationProperties() {
[NOTE]
====
-The recommendations in this section no longer apply if using the xref:rg:cms:classes/AppManifest2-bootstrapping.adoc#bootstrapping[`AppManifest2`] interface and ``Module``s to bootstrap your application.
+The recommendations in this section no longer apply if using the xref:rg:cms:classes.adoc#bootstrapping[`AppManifest2`] interface and ``Module``s to bootstrap your application.
====
One of the primary goals of the `AppManifest` is to unify the bootstrapping of both integration tests and the webapp.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/AppManifest2-bootstrapping.adoc b/core/_adoc-rg/modules/cms/pages/classes/AppManifest2-bootstrapping.adoc
index f03e7d9..4c1b523 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/AppManifest2-bootstrapping.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/AppManifest2-bootstrapping.adoc
@@ -41,7 +41,7 @@ Specifically, only the `Builder` can specify the authentication mechanism, and o
== API
-The `AppManifest2` interface extends xref:rg:cms:classes/AppManifest-bootstrapping.adoc#api[`AppManifest`], additionally declaring the top-level `Module` that was used to create the app manifest, and fixtures for reference data setup and for teardown:
+The `AppManifest2` interface extends xref:rg:cms:classes.adoc#api[`AppManifest`], additionally declaring the top-level `Module` that was used to create the app manifest, and fixtures for reference data setup and for teardown:
[source,java]
----
@@ -75,7 +75,7 @@ public abstract class AppManifestAbstract2 extends AppManifestAbstract implement
}
----
-Additional `withXxx(...)` builder methods are inherited from xref:rg:cms:classes/AppManifest-bootstrapping.adoc#bootstrapping[`AppManifestAbstract.Builder`].
+Additional `withXxx(...)` builder methods are inherited from xref:rg:cms:classes.adoc#bootstrapping[`AppManifestAbstract.Builder`].
For example:
@@ -119,9 +119,9 @@ 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:rg:ant:DomainService.adoc[`@DomainService`].
-<4> Optionally each `Module` can define a xref:rg:cms:classes/super.adoc#FixtureScript[`FixtureScript`] which holds immutable "reference data".
+<4> Optionally each `Module` can define a xref:rg:cms:classes.adoc#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:rg:cms:classes/super.adoc#FixtureScript[`FixtureScript`], used to remove the contents of _all_ entities (both reference data and operational/transactional data).
+<5> Similarly, optionally each `Module` can define a tear-down xref:rg:cms:classes.adoc#FixtureScript[`FixtureScript`], used to remove the contents of _all_ entities (both reference data and operational/transactional data).
<6> Optionally each module can define additional configuration properties.
These can either be specified as key-value pair, or by way of the `PropertyResource` class.
The `PropertyResource` class identifies a property configuration file to load from the classpath, with respect to some other context class.
@@ -177,7 +177,7 @@ Alternatively, could override `getAdditonalServices()`.
== Bootstrapping
One of the overarching goals is to ensure that integration tests and the webapp are bootstrapped in as similar a way as possible.
-xref:rg:cms:classes/AppManifest-bootstrapping.adoc#bootstrapping[Previously] this was done by using a single `AppManifest` for both the tests and the webapp.
+xref:rg:cms:classes.adoc#bootstrapping[Previously] this was done by using a single `AppManifest` for both the tests and the webapp.
However, this approach does have a significant drawback.
The `AppManifest` implementation must (necessarily) reference all the modules wthin the application, and this therefore means that the integration tests are also scoped (or at least, have access to) the entire application.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/contributee.adoc b/core/_adoc-rg/modules/cms/pages/classes/contributee.adoc
index e86fe72..7ee5f69 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/contributee.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/contributee.adoc
@@ -1,6 +1,7 @@
= Contributee
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The interfaces listed in this chapter act as contributees; they allow domain services to contribute actions/properties/collections to any domain objects that implement these interfaces.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/contributee/HasTransactionId.adoc b/core/_adoc-rg/modules/cms/pages/classes/contributee/HasTransactionId.adoc
index 5f5c57b..deecf4c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/contributee/HasTransactionId.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/contributee/HasTransactionId.adoc
@@ -2,6 +2,7 @@
= `HasTransactionId`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `HasTransactionId` interface is a mix-in for any domain objects that reference a transaction id, such as
@@ -42,7 +43,7 @@ public interface RepresentsInteractionMemberExecution extends HasTransactionId {
}
----
-Here the (inherited) `getTransactionId()` is intended to be interpreted as an interaction (cf xref:rg:cms:schema/ixn.adoc[`InteractionDto`]) that has at least one member execution (cf xref:rg:cms:schema/ixn/memberExecutionDto.adoc[`memberExecutionDto`]).
+Here the (inherited) `getTransactionId()` is intended to be interpreted as an interaction (cf xref:rg:cms:schema.adoc#ixn[`InteractionDto`]) that has at least one member execution (cf xref:rg:cms:schema.adoc#ixn/memberExecutionDto[`memberExecutionDto`]).
If the interaction (almost certainly an action) calls other actions by way of xref:rg:svc:WrapperFactory.adoc[`WrapperFactory`]), then there may be several member executions, each with a unique sequence number, within the same transaction Id.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/contributee/HasUserName.adoc b/core/_adoc-rg/modules/cms/pages/classes/contributee/HasUserName.adoc
index a7b3e5b..bd2ad5c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/contributee/HasUserName.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/contributee/HasUserName.adoc
@@ -2,6 +2,7 @@
= `HasUsername`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `HasUsername` interface is a mix-in for domain objects to be associated with a username.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/domainevent.adoc b/core/_adoc-rg/modules/cms/pages/classes/domainevent.adoc
index 1efb558..2ba02e9 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/domainevent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/domainevent.adoc
@@ -1,6 +1,7 @@
= Domain Event Classes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This section catalogues the various domain event classes defined by Apache Isis.
@@ -21,7 +22,7 @@ Impl'n (g: a:)
|Notes
-|xref:rg:cms:classes/domainevent.adoc#AbstractDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#AbstractDomainEvent[`o.a.i.applib.` +
`AbstractDomainEvent`]
|``o.a.i.core`` +
``events.domain`` +
@@ -30,7 +31,7 @@ Impl'n (g: a:)
|Superclass of the other domain events, listed below in this table.
-|xref:rg:cms:classes/domainevent.adoc#ActionDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ActionDomainEvent[`o.a.i.applib.` +
`ActionDomainEvent`]
|``o.a.i.core`` +
``events.domain`` +
@@ -40,7 +41,7 @@ Impl'n (g: a:)
|Broadcast whenever there is an interaction (hide/disable/validate/pre-execute/post-execute) with an object's action.
-|xref:rg:cms:classes/domainevent.adoc#CollectionDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#CollectionDomainEvent[`o.a.i.applib.` +
`CollectionDomainEvent`]
|``o.a.i.core`` +
``events.domain`` +
@@ -51,7 +52,7 @@ is specified.
|Broadcast whenever there is an interaction (hide/disable/validate/access) with an object's collection.
-|xref:rg:cms:classes/domainevent.adoc#PropertyDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#PropertyDomainEvent[`o.a.i.applib.` +
`PropertyDomainEvent`]
|``o.a.i.core`` +
``events.domain`` +
diff --git a/core/_adoc-rg/modules/cms/pages/classes/domainevent/AbstractDomainEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/domainevent/AbstractDomainEvent.adoc
index b77dc4a..69b504e 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/domainevent/AbstractDomainEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/domainevent/AbstractDomainEvent.adoc
@@ -2,6 +2,7 @@
= `AbstractDomainEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This class is the superclass for all domain events that are raised by the framework when interacting with actions,
@@ -9,9 +10,9 @@ properties or collections.
Its immediate subclasses are:
-* xref:rg:cms:classes/domainevent.adoc#ActionDomainEvent[`ActionDomainEvent`]
-* xref:rg:cms:classes/domainevent.adoc#PropertyDomainEvent[`PropertyDomainEvent`]
-* xref:rg:cms:classes/domainevent.adoc#CollectionDomainEvent[`CollectionDomainEvent`]
+* xref:rg:cms:classes.adoc#ActionDomainEvent[`ActionDomainEvent`]
+* xref:rg:cms:classes.adoc#PropertyDomainEvent[`PropertyDomainEvent`]
+* xref:rg:cms:classes.adoc#CollectionDomainEvent[`CollectionDomainEvent`]
The main purpose of the class is to define the protocol by which subscribers can influence an interaction (eg hide a
collection, disable a property, validate action arguments). It class also provides a simple mechanism to allow
diff --git a/core/_adoc-rg/modules/cms/pages/classes/domainevent/ActionDomainEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/domainevent/ActionDomainEvent.adoc
index 76ba5ab..8d81ddb 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/domainevent/ActionDomainEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/domainevent/ActionDomainEvent.adoc
@@ -2,9 +2,10 @@
= `ActionDomainEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/domainevent.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for actions.
+Subclass of xref:rg:cms:classes.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for actions.
The class has a number of responsibilities (in addition to those it inherits):
diff --git a/core/_adoc-rg/modules/cms/pages/classes/domainevent/CollectionDomainEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/domainevent/CollectionDomainEvent.adoc
index 7e6bc5f..b5e4310 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/domainevent/CollectionDomainEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/domainevent/CollectionDomainEvent.adoc
@@ -2,9 +2,10 @@
= `CollectionDomainEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/domainevent.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for collections.
+Subclass of xref:rg:cms:classes.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for collections.
The class has a couple of responsibilities (in addition to those it inherits):
diff --git a/core/_adoc-rg/modules/cms/pages/classes/domainevent/PropertyDomainEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/domainevent/PropertyDomainEvent.adoc
index a0c74d1..ad0c349 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/domainevent/PropertyDomainEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/domainevent/PropertyDomainEvent.adoc
@@ -2,9 +2,10 @@
= `PropertyDomainEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/domainevent.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for properties.
+Subclass of xref:rg:cms:classes.adoc#AbstractDomainEvent[`AbstractDomainEvent`] for properties.
The class has a couple of responsibilities (in addition to those it inherits):
diff --git a/core/_adoc-rg/modules/cms/pages/classes/i18n.adoc b/core/_adoc-rg/modules/cms/pages/classes/i18n.adoc
index 63ba110..c126af9 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/i18n.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/i18n.adoc
@@ -1,6 +1,7 @@
= i18n support
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `org.apache.isis.applib.services.i18n` package contains a single class to support i18n.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/i18n/TranslatableString.adoc b/core/_adoc-rg/modules/cms/pages/classes/i18n/TranslatableString.adoc
index ea7a8da..2671b18 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/i18n/TranslatableString.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/i18n/TranslatableString.adoc
@@ -2,6 +2,7 @@
= `TranslatableString`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
IMPORTANT: FIXME - see xref:ug:btb:i18n.adoc[user guide, i18n].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/layout.adoc b/core/_adoc-rg/modules/cms/pages/classes/layout.adoc
index 1d6017c..391611e 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/layout.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/layout.adoc
@@ -1,6 +1,7 @@
= (Object) Layout
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `org.apache.isis.applib.layout.grid` and `org.apache.isis.applib.layout.component` packages together define a number of classes that allow the layout of domain objects (entities and view models) to be customized.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent.adoc
index f90c581..5ceb9d2 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent.adoc
@@ -1,6 +1,7 @@
= Lifecycle Events
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This section catalogues the various lifecycle event classes defined by Apache Isis.
@@ -20,7 +21,7 @@ Impl'n (g: a:)
|Notes
-|xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`o.a.i.applib.` +
`AbstractLifecycleEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -29,7 +30,7 @@ Impl'n (g: a:)
|Superclass of the other lifecycle events, listed below in this table.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectCreatedDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectCreatedDomainEvent[`o.a.i.applib.` +
`ObjectCreatedEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -40,7 +41,7 @@ Impl'n (g: a:)
`#instantiate(...)` method.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectLoadedDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectLoadedDomainEvent[`o.a.i.applib.` +
`ObjectLoadedEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -50,7 +51,7 @@ Impl'n (g: a:)
|Broadcast when an object is retrieved from the database.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistedDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectPersistedDomainEvent[`o.a.i.applib.` +
`ObjectPersistedEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -61,7 +62,7 @@ Impl'n (g: a:)
`#persist(...)` method.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistingDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectPersistingDomainEvent[`o.a.i.applib.` +
`ObjectPersistingEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -72,7 +73,7 @@ Impl'n (g: a:)
`#persist(...)` method.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectRemovingDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectRemovingDomainEvent[`o.a.i.applib.` +
`ObjectRemovingEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -83,7 +84,7 @@ Impl'n (g: a:)
`#remove(...)` method.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatedDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectUpdatedDomainEvent[`o.a.i.applib.` +
`ObjectUpdatedEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
@@ -94,7 +95,7 @@ Impl'n (g: a:)
This is done either explicitly when the current transaction is flushed using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
-|xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatingDomainEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#ObjectUpdatingDomainEvent[`o.a.i.applib.` +
`ObjectUpdatingEvent`]
|``o.a.i.core`` +
``events.lifecycle`` +
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/AbstractLifecycleEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/AbstractLifecycleEvent.adoc
index ed46951..a33bacb 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/AbstractLifecycleEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/AbstractLifecycleEvent.adoc
@@ -2,6 +2,7 @@
= `AbstractLifecycleEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This class is the superclass for all lifecycle events that are raised by the framework when loading, saving, updating
@@ -9,12 +10,12 @@ or deleting objects from the database.
Its immediate subclasses are:
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectCreatedEvent[`ObjectCreatedEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectLoadedEvent[`ObjectLoadedEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistedEvent[`ObjectPersistedEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistingEvent[`ObjectPersistingEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectRemovingEvent[`ObjectRemovingEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatedEvent[`ObjectUpdatedEvent`]
-* xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatingEvent[`ObjectUpdatingEvent`]
+* xref:rg:cms:classes.adoc#ObjectCreatedEvent[`ObjectCreatedEvent`]
+* xref:rg:cms:classes.adoc#ObjectLoadedEvent[`ObjectLoadedEvent`]
+* xref:rg:cms:classes.adoc#ObjectPersistedEvent[`ObjectPersistedEvent`]
+* xref:rg:cms:classes.adoc#ObjectPersistingEvent[`ObjectPersistingEvent`]
+* xref:rg:cms:classes.adoc#ObjectRemovingEvent[`ObjectRemovingEvent`]
+* xref:rg:cms:classes.adoc#ObjectUpdatedEvent[`ObjectUpdatedEvent`]
+* xref:rg:cms:classes.adoc#ObjectUpdatingEvent[`ObjectUpdatingEvent`]
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectCreatedEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectCreatedEvent.adoc
index fbe13fc..bb4bc62 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectCreatedEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectCreatedEvent.adoc
@@ -2,10 +2,11 @@
= `ObjectCreatedEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first instantiated using the xref:rg:svc:core-domain-api/FactoryService.adoc[`FactoryServuce`]'s `#instantiate(...)` method.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first instantiated using the xref:rg:svc:core-domain-api/FactoryService.adoc[`FactoryServuce`]'s `#instantiate(...)` method.
`ObjectCreatedEvent.Default` is the implementation that is used by default, but this can be overridden using xref:rg:ant:DomainObject.adoc#createdLifecycleEvent[`@DomainObject#createdLifecycleEvent()`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectLoadedEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectLoadedEvent.adoc
index 31f552b..1f7cc32 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectLoadedEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectLoadedEvent.adoc
@@ -2,10 +2,11 @@
= `ObjectLoadedEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is retrieved from the database.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is retrieved from the database.
`ObjectLoadedEvent.Default` is the concrete implementation that is used.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistedEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistedEvent.adoc
index c404d58..fbf6c5b 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistedEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistedEvent.adoc
@@ -2,9 +2,10 @@
= `ObjectPersistedEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first saved (inserted) into the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#persist(...)` method.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first saved (inserted) into the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#persist(...)` method.
`ObjectPersistedEvent.Default` is the implementation that is used by default, but this can be overridden using xref:rg:ant:DomainObject.adoc#persistedLifecycleEvent[`@DomainObject#persistedLifecycleEvent()`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistingEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistingEvent.adoc
index 31b352e..db62147 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistingEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectPersistingEvent.adoc
@@ -2,9 +2,10 @@
= `ObjectPersistingEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be saved (inserted) into the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#persist(...)` method.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be saved (inserted) into the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#persist(...)` method.
`ObjectPersistingEvent.Default` is the implementation that is used by default, but this can be overridden using xref:rg:ant:DomainObject.adoc#persistingLifecycleEvent[`@DomainObject#persistingLifecycleEvent()`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectRemovingEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectRemovingEvent.adoc
index 71dd0cb..3034b2e 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectRemovingEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectRemovingEvent.adoc
@@ -2,9 +2,10 @@
= `ObjectRemovingEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be deleted from the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#remove(...)` method.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be deleted from the database using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#remove(...)` method.
`ObjectRemovingEvent.Default` is the implementation that is used by default, but this can be overridden using xref:rg:ant:DomainObject.adoc#removingLifecycleEvent[`@DomainObject#removingLifecycleEvent()`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatedEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatedEvent.adoc
index aa8896e..bad0357 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatedEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatedEvent.adoc
@@ -2,10 +2,11 @@
= `ObjectUpdatedEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object has just been updated in the database.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object has just been updated in the database.
This is done either explicitly when the current transaction is flushed using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
`ObjectUpdatedEvent.Default` is the implementation that is used by default, but this can be overridden using xref:rg:ant:DomainObject.adoc#updatedLifecycleEvent[`@DomainObject#updatedLifecycleEvent()`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatingEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatingEvent.adoc
index 97f28f0..bef48e0 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatingEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/lifecycleevent/ObjectUpdatingEvent.adoc
@@ -2,10 +2,11 @@
= `ObjectUpdatingEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-Subclass of xref:rg:cms:classes/lifecycleevent.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be updated in the database.
+Subclass of xref:rg:cms:classes.adoc#AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be updated in the database.
This is done either explicitly when the current transaction is flushed using the xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService`]'s `#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/menubars.adoc b/core/_adoc-rg/modules/cms/pages/classes/menubars.adoc
index 38cdfc0..6642203 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/menubars.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/menubars.adoc
@@ -1,6 +1,7 @@
= MenuBars Layout
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `org.apache.isis.applib.layout.menubars` package and subpackages define a number of interfaces classes that allow the layout of domain service actions to be organised across menu bars, menus and menu sections.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/mixins.adoc b/core/_adoc-rg/modules/cms/pages/classes/mixins.adoc
index ab6b820..0ced61e 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/mixins.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/mixins.adoc
@@ -1,6 +1,7 @@
= Mixins
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This chapter defines a number of role interfaces that definea contract for some framework-defined mixins.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/mixins/Dto.adoc b/core/_adoc-rg/modules/cms/pages/classes/mixins/Dto.adoc
index 43b164b..8997c4f 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/mixins/Dto.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/mixins/Dto.adoc
@@ -2,6 +2,7 @@
= `Dto`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `Dto` role interface is intended to be implemented by JAXB-annotated view models, that is, annotated using
@@ -29,7 +30,7 @@ public class Dto_downloadXml {
<1> provided as an action to any class that (trivially) implements the `Dto` interface
<2> The action's name is derived from the class name.
-This will return the XML text wrapped up in a xref:rg:cms:classes/value-types.adoc#Clob[`Clob`].
+This will return the XML text wrapped up in a xref:rg:cms:classes.adoc#Clob[`Clob`].
The `Dto_downloadXsd` mixin is similar:
@@ -44,8 +45,8 @@ public class Dto_downloadXsd {
<1> provided as an action to any class that (trivially) implements the `Dto` interface
<2> The action's name be derived from the class name.
-If the domain object's JAXB annotations reference only a single XSD schema then this will return that XML text as a xref:rg:cms:classes/value-types.adoc#Clob[`Clob`] of that XSD.
-If there are multiple XSD schemas referenced then the action will return a zip of those schemas, wrapped up in a xref:rg:cms:classes/value-types.adoc#Blob[`Blob`].
+If the domain object's JAXB annotations reference only a single XSD schema then this will return that XML text as a xref:rg:cms:classes.adoc#Clob[`Clob`] of that XSD.
+If there are multiple XSD schemas referenced then the action will return a zip of those schemas, wrapped up in a xref:rg:cms:classes.adoc#Blob[`Blob`].
The `IsisSchemas` parameter to the action can be used to optionally ignore the common xref:rg:cms:schema.adoc[Apache Isis schemas] (useful if there is only one other XSD schema referenced by the DTO).
diff --git a/core/_adoc-rg/modules/cms/pages/classes/mixins/Object.adoc b/core/_adoc-rg/modules/cms/pages/classes/mixins/Object.adoc
index 73386f3..c4f2053 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/mixins/Object.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/mixins/Object.adoc
@@ -2,13 +2,14 @@
= `Object`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The framework provides a single mixin that contributes to simply `java.lang.Object`.
It provides the ability to download the layout XML for any domain object (in practical terms: entities and view models).
These mixin actions are all associated with the "Metadata" fieldset.
-A number of other xref:rg:cms:classes/mixins.adoc#Persistable[mixins] also contribute properties or actions to the "Metadata" fieldset.
+A number of other xref:rg:cms:classes.adoc#Persistable[mixins] also contribute properties or actions to the "Metadata" fieldset.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/mixins/Persistable.adoc b/core/_adoc-rg/modules/cms/pages/classes/mixins/Persistable.adoc
index acae9ef..92ca74c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/mixins/Persistable.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/mixins/Persistable.adoc
@@ -2,13 +2,14 @@
= `Persistable`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
All domain entities automatically implement the DataNucleus `Persistable` role interface as a result of the enhancer process (the fully qualified class name is `org.datanucleus.enhancement.Persistable`).
So as a developer you do not need to write any code to obtain the mixins that contribute to this interface.
These mixin properties/actions are all associated with the "Metadata" fieldset.
-A number of other xref:rg:cms:classes/mixins.adoc#Object[mixins] also contribute properties or actions to the "Metadata" fieldset.
+A number of other xref:rg:cms:classes.adoc#Object[mixins] also contribute properties or actions to the "Metadata" fieldset.
@@ -25,7 +26,7 @@ public Clob downloadJdoMetadata( // <1>
...
}
----
-<1> returns the XML text wrapped up in a xref:rg:cms:classes/value-types.adoc#Clob[`Clob`].
+<1> returns the XML text wrapped up in a xref:rg:cms:classes.adoc#Clob[`Clob`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/roles.adoc b/core/_adoc-rg/modules/cms/pages/classes/roles.adoc
index 25c19a4..ecaf165 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/roles.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/roles.adoc
@@ -1,6 +1,7 @@
= Roles
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The interfaces listed in this chapter are role interfaces; they define a contract for the framework to interact with those domain objects that implement these interfaces.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedAt.adoc b/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedAt.adoc
index 55d8465..4dcabb3 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedAt.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedAt.adoc
@@ -2,6 +2,7 @@
= `HoldsUpdatedAt`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `HoldsUpdatedAt` role interface allows the (framework-provided) `TimestampService` to update each object with the current timestamp whenever it is modified in a transaction.
@@ -17,7 +18,7 @@ public interface HoldsUpdatedAt {
The current time is obtained from the xref:rg:svc:core-domain-api/ClockService.adoc[`ClockService`].
-Entities that implement this interface often also implement xref:rg:cms:classes/roles.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] role interface; as a convenience the xref:rg:cms:classes/roles.adoc#Timestampable[`Timestampable`] interface combines the two roles.
+Entities that implement this interface often also implement xref:rg:cms:classes.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] role interface; as a convenience the xref:rg:cms:classes.adoc#Timestampable[`Timestampable`] interface combines the two roles.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedBy.adoc b/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedBy.adoc
index dc42052..aeb8301 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedBy.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/roles/HoldsUpdatedBy.adoc
@@ -2,6 +2,7 @@
= `HoldsUpdatedBy`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `HoldsUpdatedBy` role interface ...
@@ -15,6 +16,6 @@ public interface HoldsUpdatedBy {
}
----
-Entities that implement this interface often also implement xref:rg:cms:classes/roles.adoc#HoldsUpdatedAt[`HoldsUpdatedAt`] role interface; as a convenience the xref:rg:cms:classes/roles.adoc#Timestampable[`Timestampable`] interface combines the two roles.
+Entities that implement this interface often also implement xref:rg:cms:classes.adoc#HoldsUpdatedAt[`HoldsUpdatedAt`] role interface; as a convenience the xref:rg:cms:classes.adoc#Timestampable[`Timestampable`] interface combines the two roles.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/roles/Timestampable.adoc b/core/_adoc-rg/modules/cms/pages/classes/roles/Timestampable.adoc
index b2ece0e..9bab86c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/roles/Timestampable.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/roles/Timestampable.adoc
@@ -2,9 +2,10 @@
= `Timestampable`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-The `Timestampable` role interface is a convenience that combines the xref:rg:cms:classes/roles.adoc#HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:rg:cms:classes/roles.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces.
+The `Timestampable` role interface is a convenience that combines the xref:rg:cms:classes.adoc#HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:rg:cms:classes.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces.
It is defined as:
[source,java]
@@ -22,4 +23,4 @@ The interface no additional methods of its own.
An alternative way to maintain a timestamp is to use JDO's `@Version` annotation.
With this approach, it is the JDO/DataNucleus that maintains the version, rather than the framework's `TimestampService`.
-See xref:rg:cms:classes/roles.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
+See xref:rg:cms:classes.adoc#HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/spec.adoc b/core/_adoc-rg/modules/cms/pages/classes/spec.adoc
index f8af29b..92ff6ad 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/spec.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/spec.adoc
@@ -1,6 +1,7 @@
= Specification pattern
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The interfaces and classes listed in this chapter provide support for the `Specification` pattern, as described in Eric Evans' book _Domain Driven Design_, p224.
@@ -49,7 +50,7 @@ public class Customer {
== `Specification2`
The `Specification2` interface extends the `Specification` API to add support for i18n.
-This is done by defining an additional method that returns a xref:rg:cms:classes/i18n.adoc#TranslatableString[translatable string]:
+This is done by defining an additional method that returns a xref:rg:cms:classes.adoc#TranslatableString[translatable string]:
[source,java]
----
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super.adoc b/core/_adoc-rg/modules/cms/pages/classes/super.adoc
index 7c954b2..69ca598 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super.adoc
@@ -1,6 +1,7 @@
= Superclasses
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This section catalogues the various convenience (non event) superclasses defined by Apache Isis.
@@ -18,7 +19,7 @@ Impl'n (g: a:)
|Notes
-|xref:rg:cms:classes/super.adoc#AbstractService[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#AbstractService[`o.a.i.applib.` +
`AbstractService`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -26,7 +27,7 @@ Impl'n (g: a:)
|
-|xref:rg:cms:classes/super.adoc#AbstractSubscriber[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#AbstractSubscriber[`o.a.i.applib.` +
`AbstractSubscriber`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -34,7 +35,7 @@ Impl'n (g: a:)
|
-|xref:rg:cms:classes/super.adoc#AbstractViewModel[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#AbstractViewModel[`o.a.i.applib.` +
`AbstractViewModel`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -42,7 +43,7 @@ Impl'n (g: a:)
|
-|xref:rg:cms:classes/super.adoc#FixtureScript[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#FixtureScript[`o.a.i.applib.` +
`fixturescript` +
`FixtureScript`]
|``o.a.i.core`` +
@@ -51,7 +52,7 @@ Impl'n (g: a:)
|
-|xref:rg:cms:classes/super.adoc#FixtureScripts[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#FixtureScripts[`o.a.i.applib.` +
`fixturescripts` +
`FixtureScripts`]
|``o.a.i.core`` +
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractService.adoc b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractService.adoc
index 64a04ae..1f13db4 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractService.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractService.adoc
@@ -2,6 +2,7 @@
= `AbstractService`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This class provides an implementation of the optional `getId()` method for domain services, based upon the classes name.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractSubscriber.adoc b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractSubscriber.adoc
index 967a641..284597d 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractSubscriber.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractSubscriber.adoc
@@ -2,6 +2,7 @@
= `AbstractSubscriber`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This is a convenience superclass for creating subscriber domain services on the xref:rg:svc:core-domain-api/EventBusService.adoc[`EventBusService`].
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractViewModel.adoc b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractViewModel.adoc
index 5ff4821..6ce091c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super/AbstractViewModel.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super/AbstractViewModel.adoc
@@ -2,9 +2,10 @@
= `AbstractViewModel`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-This class simply implements the xref:rg:cms:classes/super.adoc#ViewModel[`ViewModel`] interface, however the methods are still abstract.
+This class simply implements the xref:rg:cms:classes.adoc#ViewModel[`ViewModel`] interface, however the methods are still abstract.
In and of itself it provides no new behaviour.
[TIP]
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScript.adoc b/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScript.adoc
index 3105f07..578d56a 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScript.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScript.adoc
@@ -2,6 +2,7 @@
= `FixtureScript`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `FixtureScript` class is an abstract class defining an API to set up data within the object store, either for integration tests or while demoing/prototyping.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScripts.adoc b/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScripts.adoc
index 30f0eea..b6ac514 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScripts.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/super/FixtureScripts.adoc
@@ -2,8 +2,9 @@
= `FixtureScripts`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-This abstract class constitutes the API of a domain service to execute xref:rg:cms:classes/super.adoc#FixtureScript[`FixtureScript`]s.
+This abstract class constitutes the API of a domain service to execute xref:rg:cms:classes.adoc#FixtureScript[`FixtureScript`]s.
For more information, see xref:rg:svc:testing/FixtureScripts.adoc[`FixtureScripts`] in the domain services guide.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/uievent.adoc b/core/_adoc-rg/modules/cms/pages/classes/uievent.adoc
index 72453af..9a50c66 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/uievent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/uievent.adoc
@@ -1,6 +1,7 @@
= UI Event Classes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This section catalogues the various UI event classes defined by Apache Isis.
@@ -21,32 +22,32 @@ Impl'n (g: a:)
|Notes
-|xref:rg:cms:classes/uievent.adoc#TitleUiEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#TitleUiEvent[`o.a.i.applib.` +
`TitleUiEvent`]
|``o.a.i.core`` +
``events.ui`` +
``isis-core-applib``
|(abstract class). +
`TitleUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#titleUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain a title for a domain object. Note that if the domain object defines its own xref:rg:cms:methods/reserved.adoc#title[`title()`] supporting method, or has xref:rg:ant:Title.adoc[`@Title`] annotation(s) on its properties, then these will take precedence.
+|Broadcast whenever there is a requirement to obtain a title for a domain object. Note that if the domain object defines its own xref:rg:cms:methods.adoc#title[`title()`] supporting method, or has xref:rg:ant:Title.adoc[`@Title`] annotation(s) on its properties, then these will take precedence.
-|xref:rg:cms:classes/uievent.adoc#IconUiEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#IconUiEvent[`o.a.i.applib.` +
`IconUiEvent`]
|``o.a.i.core`` +
``events.ui`` +
``isis-core-applib``
|(abstract class). +
`IconUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#iconUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain an icon (or rather, the name of an icon) for a domain object. Note that if the domain object defines its own xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] supporting method, or if it has the xref:rg:ant:DomainObjectLayout#cssClassFa.adoc[`@DomainObjectLayout#cssClassFa()`] attribute, then these will take precedence.
+|Broadcast whenever there is a requirement to obtain an icon (or rather, the name of an icon) for a domain object. Note that if the domain object defines its own xref:rg:cms:methods.adoc#iconName[`iconName()`] supporting method, or if it has the xref:rg:ant:DomainObjectLayout#cssClassFa.adoc[`@DomainObjectLayout#cssClassFa()`] attribute, then these will take precedence.
-|xref:rg:cms:classes/uievent.adoc#CssClassUiEvent[`o.a.i.applib.` +
+|xref:rg:cms:classes.adoc#CssClassUiEvent[`o.a.i.applib.` +
`CssClassUiEvent`]
|``o.a.i.core`` +
``events.ui`` +
``isis-core-applib``
|(abstract class). +
`CssClassUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#cssClassUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain a CSS class hint for a domain object. Note that if the domain object defines its own xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`] supporting method then this
+|Broadcast whenever there is a requirement to obtain a CSS class hint for a domain object. Note that if the domain object defines its own xref:rg:cms:methods.adoc#cssClass[`cssClass()`] supporting method then this
will take precedence.
|===
diff --git a/core/_adoc-rg/modules/cms/pages/classes/uievent/CssClassUiEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/uievent/CssClassUiEvent.adoc
index e737514..978a4f9 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/uievent/CssClassUiEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/uievent/CssClassUiEvent.adoc
@@ -2,6 +2,7 @@
= `CssClassUiEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This event class represents a request to obtain the a CSS class hint of a domain object. The class has a number of
@@ -16,6 +17,6 @@ The class itself is instantiated automatically by the framework whenever interac
[NOTE]
====
-if the domain object defines its own xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`] supporting
+if the domain object defines its own xref:rg:cms:methods.adoc#cssClass[`cssClass()`] supporting
method then this will take precedence.
====
diff --git a/core/_adoc-rg/modules/cms/pages/classes/uievent/IconUiEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/uievent/IconUiEvent.adoc
index 8e7e90c..69064b2 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/uievent/IconUiEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/uievent/IconUiEvent.adoc
@@ -2,6 +2,7 @@
= `IconUiEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This event class represents a request to obtain the icon (or rather, name of icon) of a domain object. The class has a number of responsibilities:
@@ -15,7 +16,7 @@ The class itself is instantiated automatically by the framework whenever interac
[NOTE]
====
-If the domain object defines its own xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] supporting method,
+If the domain object defines its own xref:rg:cms:methods.adoc#iconName[`iconName()`] supporting method,
or if it has the
xref:rg:ant:DomainObjectLayout#cssClassFa.adoc[`@DomainObjectLayout#cssClassFa()`] attribute, then
these will take precedence.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/uievent/TitleUiEvent.adoc b/core/_adoc-rg/modules/cms/pages/classes/uievent/TitleUiEvent.adoc
index 564c7c4..1e561e5 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/uievent/TitleUiEvent.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/uievent/TitleUiEvent.adoc
@@ -2,6 +2,7 @@
= `TitleUiEvent`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
This event class represents a request to obtain the title of a domain object. The class has a number of responsibilities:
@@ -15,7 +16,7 @@ The class itself is instantiated automatically by the framework whenever interac
[NOTE]
====
-If the domain object defines its own xref:rg:cms:methods/reserved.adoc#title[`title()`] supporting method, or
+If the domain object defines its own xref:rg:cms:methods.adoc#title[`title()`] supporting method, or
has xref:rg:ant:Title.adoc[`@Title`] annotation(s) on its properties, then these will take
precedence.
====
diff --git a/core/_adoc-rg/modules/cms/pages/classes/utility.adoc b/core/_adoc-rg/modules/cms/pages/classes/utility.adoc
index 69cb047..2588b7e 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/utility.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/utility.adoc
@@ -1,6 +1,7 @@
= Applib Utility Classes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `org.apache.isis.applib.util` package has a number of simple utility
classes designed to simplify the coding of some common tasks.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/utility/Enums.adoc b/core/_adoc-rg/modules/cms/pages/classes/utility/Enums.adoc
index 5e65f9a..a0d1593 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/utility/Enums.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/utility/Enums.adoc
@@ -2,6 +2,7 @@
= `Enums`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
NOTE: FIXME
diff --git a/core/_adoc-rg/modules/cms/pages/classes/utility/ObjectContracts.adoc b/core/_adoc-rg/modules/cms/pages/classes/utility/ObjectContracts.adoc
index a411efc..d6a97fe 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/utility/ObjectContracts.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/utility/ObjectContracts.adoc
@@ -2,6 +2,7 @@
= `ObjectContracts2`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `ObjectContracts2` utility class provides a series of methods to make it easy for your domain objects to:
diff --git a/core/_adoc-rg/modules/cms/pages/classes/utility/Reasons.adoc b/core/_adoc-rg/modules/cms/pages/classes/utility/Reasons.adoc
index 4934790..5f56ea6 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/utility/Reasons.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/utility/Reasons.adoc
@@ -2,6 +2,7 @@
= `Reasons`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
diff --git a/core/_adoc-rg/modules/cms/pages/classes/utility/TitleBuffer.adoc b/core/_adoc-rg/modules/cms/pages/classes/utility/TitleBuffer.adoc
index c5c9e37..80d77c4 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/utility/TitleBuffer.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/utility/TitleBuffer.adoc
@@ -2,9 +2,10 @@
= `TitleBuffer`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
-The `TitleBuffer` utility class is intended to make it easy to construct title strings (returned from the xref:rg:cms:methods/reserved.adoc#title[`title()`] method).
+The `TitleBuffer` utility class is intended to make it easy to construct title strings (returned from the xref:rg:cms:methods.adoc#title[`title()`] method).
For example, it has overloaded versions of methods called `append()` and `concat()`.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types.adoc
index 1732879..f169a0c 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types.adoc
@@ -1,6 +1,7 @@
= Value Types
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
Apache Isis can render and persist all of the JDK primitives and wrapper classes, and a number of other JDK (7.x) classes that represent value types.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Blob.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Blob.adoc
index 06c89b1..f19d003 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Blob.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Blob.adoc
@@ -1,6 +1,7 @@
= `Blob`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
`Blob` (in the `org.apache.isis.applib.value` package) is a value type defined by the Apache Isis framework to
@@ -44,5 +45,5 @@ private Blob someImage;
[TIP]
====
-For character large objects, use xref:rg:cms:classes/value-types.adoc#Clob[`Clob`] value type.
+For character large objects, use xref:rg:cms:classes.adoc#Clob[`Clob`] value type.
====
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Clob.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Clob.adoc
index 0306447..963114f 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Clob.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Clob.adoc
@@ -1,6 +1,7 @@
= `Clob`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
`Clob` (in the `org.apache.isis.applib.value` package) is a value type defined by the Apache Isis framework to
@@ -48,7 +49,7 @@ private Clob someClob;
[TIP]
====
-For binary large objects, use xref:rg:cms:classes/value-types.adoc#Blob[`Blob`] value type.
+For binary large objects, use xref:rg:cms:classes.adoc#Blob[`Blob`] value type.
====
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Color.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Color.adoc
index 0999842..33038f0 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Color.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Color.adoc
@@ -1,6 +1,7 @@
= `Color`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
NOTE: FIXME - the `org.apache.isis.applib.value.Color` class.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Markup.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Markup.adoc
index 60a3713..3518acc 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Markup.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Markup.adoc
@@ -1,6 +1,7 @@
= `Markup`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
The `Markup` value type (introduced in `1.15.1`) is intended to be used as a read-only property, to render arbitrary markup into the user interface.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Money.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Money.adoc
index 6c791c1..ffa2196 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Money.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Money.adoc
@@ -1,6 +1,7 @@
= `Money`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
NOTE: FIXME - the `org.apache.isis.applib.value.Money` class.
diff --git a/core/_adoc-rg/modules/cms/pages/classes/value-types/Password.adoc b/core/_adoc-rg/modules/cms/pages/classes/value-types/Password.adoc
index 19d8489..a1583dc 100644
--- a/core/_adoc-rg/modules/cms/pages/classes/value-types/Password.adoc
+++ b/core/_adoc-rg/modules/cms/pages/classes/value-types/Password.adoc
@@ -1,6 +1,7 @@
= `Password`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
+:page-partial:
NOTE: FIXME
diff --git a/core/_adoc-rg/modules/cms/pages/methods.adoc b/core/_adoc-rg/modules/cms/pages/methods.adoc
index 2d9ed06..b6d5bd8 100644
--- a/core/_adoc-rg/modules/cms/pages/methods.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods.adoc
@@ -10,3 +10,6 @@ This chapter documents the supporting methods and the reserved methods. It also
+include::methods/prefixes.adoc[leveloffset=+1]
+include::methods/reserved.adoc[leveloffset=+1]
+include::methods/lifecycle.adoc[leveloffset=+1]
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle.adoc
index 6f72ff7..30eb6d2 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle.adoc
@@ -1,7 +1,7 @@
= Lifecycle Methods
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
@@ -23,28 +23,28 @@ The lifecycle callback methods supported by Apache Isis are:
|Method
|Description
-|xref:rg:cms:methods/lifecycle.adoc#created[`created()`]
+|xref:rg:cms:methods.adoc#created[`created()`]
|called when an object has just been created using xref:rg:svc:core-domain-api/FactoryService.adoc[`FactoryService#instantiate(..)`] or xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService#instantiate(...)`]
-|xref:rg:cms:methods/lifecycle.adoc#loaded[`loaded()`]
+|xref:rg:cms:methods.adoc#loaded[`loaded()`]
|called when a (persistent) object has just been loaded from the object store.
-|xref:rg:cms:methods/lifecycle.adoc#persisted[`persisted()`]
+|xref:rg:cms:methods.adoc#persisted[`persisted()`]
|called when object has just been persisted from the object store.
-|xref:rg:cms:methods/lifecycle.adoc#persisting[`persisting()`]
+|xref:rg:cms:methods.adoc#persisting[`persisting()`]
|called when a (not-yet-persistent) object is just about to be persisted from the object store
-|xref:rg:cms:methods/lifecycle.adoc#removed[`removed()`]
+|xref:rg:cms:methods.adoc#removed[`removed()`]
|called when a (persistent) object has just been deleted from the object store
-|xref:rg:cms:methods/lifecycle.adoc#removing[`removing()`]
+|xref:rg:cms:methods.adoc#removing[`removing()`]
|called when a (persistent) object is just about to be deleted from the object store
-|xref:rg:cms:methods/lifecycle.adoc#updated[`updated()`]
+|xref:rg:cms:methods.adoc#updated[`updated()`]
|called when a (persistent) object has just been updated in the object store
-|xref:rg:cms:methods/lifecycle.adoc#updating[`updating()`]
+|xref:rg:cms:methods.adoc#updating[`updating()`]
|called when a (persistent) object is just about to be updated in the object store
|===
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/created.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/created.adoc
index 5a5fefa..0a1203b 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/created.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/created.adoc
@@ -9,7 +9,7 @@ The `created()` lifecycle callback method is called when an object has just been
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectCreatedEvent[`ObjectCreatedEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectCreatedEvent[`ObjectCreatedEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/loaded.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/loaded.adoc
index dd83071..ccd992c 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/loaded.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/loaded.adoc
@@ -10,5 +10,5 @@ The `loaded()` lifecycle callback method is called when a (persistent) object ha
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectLoadedEvent[`ObjectLoadedEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectLoadedEvent[`ObjectLoadedEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisted.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisted.adoc
index e275ccc..f5a85a7 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisted.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisted.adoc
@@ -7,9 +7,9 @@ include::_attributes.adoc[]
The `persisted()` lifecycle callback method is called when object has just been persisted from the object store.
-See also xref:rg:cms:methods/lifecycle.adoc#persisting[`persisting()`].
+See also xref:rg:cms:methods.adoc#persisting[`persisting()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistedEvent[`ObjectPersistedEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectPersistedEvent[`ObjectPersistedEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisting.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisting.adoc
index b1718c2..bf4c142 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisting.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/persisting.adoc
@@ -7,9 +7,9 @@ include::_attributes.adoc[]
The `persisting()` lifecycle callback method is called when a (not-yet-persistent) object is just about to be persisted from the object store
-See also xref:rg:cms:methods/lifecycle.adoc#persisted[`persisted()`].
+See also xref:rg:cms:methods.adoc#persisted[`persisted()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectPersistingEvent[`ObjectPersistingEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectPersistingEvent[`ObjectPersistingEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removed.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removed.adoc
index 99c822f..1ae44cd 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removed.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removed.adoc
@@ -7,9 +7,9 @@ include::_attributes.adoc[]
The `removed()` lifecycle callback method is called when a (persistent) object has just been deleted from the object store
-See also xref:rg:cms:methods/lifecycle.adoc#removing[`removing()`].
+See also xref:rg:cms:methods.adoc#removing[`removing()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectRemovedEvent[`ObjectRemovedEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectRemovedEvent[`ObjectRemovedEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removing.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removing.adoc
index 9b4a03f..731861d 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removing.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/removing.adoc
@@ -7,9 +7,9 @@ include::_attributes.adoc[]
The `removing()` lifecycle callback method is called when a (persistent) object is just about to be deleted from the object store
-See also xref:rg:cms:methods/lifecycle.adoc#removed[`removed()`].
+See also xref:rg:cms:methods.adoc#removed[`removed()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectRemovingEvent[`ObjectRemovingEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectRemovingEvent[`ObjectRemovingEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updated.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updated.adoc
index fe90617..546869b 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updated.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updated.adoc
@@ -9,9 +9,9 @@ include::_attributes.adoc[]
The `updated()` lifecycle callback method is called when a (persistent) object has just been updated in the object store
-See also xref:rg:cms:methods/lifecycle.adoc#updating[`updating()`].
+See also xref:rg:cms:methods.adoc#updating[`updating()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatedEvent[`ObjectUpdatedEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectUpdatedEvent[`ObjectUpdatedEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updating.adoc b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updating.adoc
index 332b28e..cada87a 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updating.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/lifecycle/updating.adoc
@@ -6,9 +6,9 @@ include::_attributes.adoc[]
The `updating()` lifecycle callback method is called when a (persistent) object is just about to be updated in the object store
-See also xref:rg:cms:methods/lifecycle.adoc#updated[`updated()`].
+See also xref:rg:cms:methods.adoc#updated[`updated()`].
[TIP]
====
-Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes/super.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes/lifecycleevent.adoc#ObjectUpdatingEvent[`ObjectUpdatingEvent`].
+Alternatively, consider using a xref:rg:svc:core-domain-api/EventBusService.adoc[event bus] xref:rg:cms:classes.adoc#AbstractSubscriber[subscriber] on the xref:rg:cms:classes.adoc#ObjectUpdatingEvent[`ObjectUpdatingEvent`].
====
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes.adoc
index b3d471e..72c2cf3 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes.adoc
@@ -1,7 +1,7 @@
= Supporting Method Prefixes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
Supporting methods are those that are associated with properties, collections and actions, providing additional imperative business rule checking and behaviour to be performed when the user interacts with those object members.
@@ -32,7 +32,7 @@ The table below lists the method prefixes that are recognized as part of Apache
Param
|Description
-|xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`]
+|xref:rg:cms:methods.adoc#addTo[`addTo...()`]
|
|
|Y
@@ -45,10 +45,10 @@ Param
Directly mutable collections are not currently supported by the xref:vw:ROOT:about.adoc[Wicket viewer].
====
-See also xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`]`
+See also xref:rg:cms:methods.adoc#removeFrom[`removeFrom...()`]`
-|xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`]
+|xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`]
|
|Y
|
@@ -59,9 +59,9 @@ See also xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`]`
Alternatively, can specify for a class using xref:rg:ant:DomainObject.adoc#autoCompleteRepository[`@DomainObject` +
`#autoCompleteRepository`] +
-See also xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`]
+See also xref:rg:cms:methods.adoc#choices[`choices...()`]
-|xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`]
+|xref:rg:cms:methods.adoc#choices[`choices...()`]
|
|Y
|
@@ -69,9 +69,9 @@ See also xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`]
|Y
|Provide list of choices for a property or action parameter. +
-See also xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`].
+See also xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`].
-|xref:rg:cms:methods/prefixes.adoc#clear[`clear...()`]
+|xref:rg:cms:methods.adoc#clear[`clear...()`]
|
|Y
|
@@ -81,10 +81,10 @@ See also xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`].
Allows business logic to be placed apart from the setter. +
-See also xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]
+See also xref:rg:cms:methods.adoc#modify[`modify...()`]
-|xref:rg:cms:methods/prefixes.adoc#default[`default...()`]
+|xref:rg:cms:methods.adoc#default[`default...()`]
|
|Y
|
@@ -92,7 +92,7 @@ See also xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]
|Y
|Default value for a property or an action parameter.
-|xref:rg:cms:methods/prefixes.adoc#disable[`disable...()`]
+|xref:rg:cms:methods.adoc#disable[`disable...()`]
|Y
|Y
|Y
@@ -100,7 +100,7 @@ See also xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]
|
|Disables (makes read-only) a property, a collection or an action.
-|xref:rg:cms:methods/prefixes.adoc#get[`get...()`]
+|xref:rg:cms:methods.adoc#get[`get...()`]
|
|Y
|Y
@@ -108,9 +108,9 @@ See also xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]
|
|Access the value of a property or collection. +
-See also xref:rg:cms:methods/prefixes.adoc#set[`set...()`].
+See also xref:rg:cms:methods.adoc#set[`set...()`].
-|xref:rg:cms:methods/prefixes.adoc#hide[`hide...()`]
+|xref:rg:cms:methods.adoc#hide[`hide...()`]
|
|Y
|Y
@@ -118,7 +118,7 @@ See also xref:rg:cms:methods/prefixes.adoc#set[`set...()`].
|
|Hides a property, a collection or an action.
-|xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]
+|xref:rg:cms:methods.adoc#modify[`modify...()`]
|
|Y
|
@@ -128,9 +128,9 @@ See also xref:rg:cms:methods/prefixes.adoc#set[`set...()`].
Allows business logic to be placed apart from the setter. +
-See also xref:rg:cms:methods/prefixes.adoc#clear[`clear...()`]`.
+See also xref:rg:cms:methods.adoc#clear[`clear...()`]`.
-|xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`]
+|xref:rg:cms:methods.adoc#removeFrom[`removeFrom...()`]
|
|
|Y
@@ -143,10 +143,10 @@ See also xref:rg:cms:methods/prefixes.adoc#clear[`clear...()`]`.
Directly mutable collections are not currently supported by the xref:vw:ROOT:about.adoc[Wicket viewer].
====
-See also xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`]`
+See also xref:rg:cms:methods.adoc#addTo[`addTo...()`]`
-|xref:rg:cms:methods/prefixes.adoc#set[`set...()`]
+|xref:rg:cms:methods.adoc#set[`set...()`]
|
|Y
|Y
@@ -154,7 +154,7 @@ See also xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`]`
|
|Sets the value of a property or a collection.
-|xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`]
+|xref:rg:cms:methods.adoc#validate[`validate...()`]
|Y
|
|
@@ -162,9 +162,9 @@ See also xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`]`
|Y
|Check that a proposed value of a property or a set of action parameters or a single action parameter is valid. +
-See also xref:rg:cms:methods/prefixes.adoc#validateAddTo[`validateAddTo...()`] and xref:rg:cms:methods/prefixes.adoc#validateRemoveFrom[`validateRemoveFrom...()`] to validate modifications to collections.
+See also xref:rg:cms:methods.adoc#validateAddTo[`validateAddTo...()`] and xref:rg:cms:methods.adoc#validateRemoveFrom[`validateRemoveFrom...()`] to validate modifications to collections.
-|xref:rg:cms:methods/prefixes.adoc#validateAddTo[`validate +
+|xref:rg:cms:methods.adoc#validateAddTo[`validate +
AddTo...()`]
|
|Y
@@ -178,9 +178,9 @@ AddTo...()`]
Directly mutable collections are not currently supported by the xref:vw:ROOT:about.adoc[Wicket viewer].
====
-See also xref:rg:cms:methods/prefixes.adoc#validateRemoveFrom[`validateRemoveFrom...()`], and xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`] for properties and actions.
+See also xref:rg:cms:methods.adoc#validateRemoveFrom[`validateRemoveFrom...()`], and xref:rg:cms:methods.adoc#validate[`validate...()`] for properties and actions.
-|xref:rg:cms:methods/prefixes.adoc#validateRemoveFrom[`validate +
+|xref:rg:cms:methods.adoc#validateRemoveFrom[`validate +
RemoveFrom...()`]
|
|Y
@@ -194,7 +194,7 @@ RemoveFrom...()`]
Directly mutable collections are not currently supported by the xref:vw:ROOT:about.adoc[Wicket viewer].
====
-See also xref:rg:cms:methods/prefixes.adoc#validateAddTo[`validateAddTo...()`], and xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`] for properties and actions.
+See also xref:rg:cms:methods.adoc#validateAddTo[`validateAddTo...()`], and xref:rg:cms:methods.adoc#validate[`validate...()`] for properties and actions.
|===
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/addTo.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/addTo.adoc
index e550672..1ba760f 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/addTo.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/addTo.adoc
@@ -33,4 +33,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`]`
+See also xref:rg:cms:methods.adoc#removeFrom[`removeFrom...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/autoComplete.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/autoComplete.adoc
index de4670b..05bb052 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/autoComplete.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/autoComplete.adoc
@@ -9,7 +9,7 @@ The `autoComplete...()` supporting method is called for action parameters and fo
[TIP]
====
-If the number of candidate objects is comparatively small, then use xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`] supporting method instead.
+If the number of candidate objects is comparatively small, then use xref:rg:cms:methods.adoc#choices[`choices...()`] supporting method instead.
====
The signature of the supporting method depends on whether it is for a parameter or a property.
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/choices.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/choices.adoc
index 6810979..73235b2 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/choices.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/choices.adoc
@@ -5,7 +5,7 @@ include::_attributes.adoc[]
-The `choices...()` supporting method is called for both action parameters and for properties, to find objects from a drop-down list box. Unlike xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`], the use case is when the number of objects is comparatively small and can be selected from a drop-down without any additional filtering.
+The `choices...()` supporting method is called for both action parameters and for properties, to find objects from a drop-down list box. Unlike xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`], the use case is when the number of objects is comparatively small and can be selected from a drop-down without any additional filtering.
The signature of the supporting method depends on whether it is for an action parameter or a property.
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/clear.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/clear.adoc
index 8899764..07d41b7 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/clear.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/clear.adoc
@@ -33,4 +33,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`]`
+See also xref:rg:cms:methods.adoc#modify[`modify...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/default.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/default.adoc
index 8d29848..aa0cc1d 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/default.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/default.adoc
@@ -180,7 +180,7 @@ public class ShoppingCartItem {
There are, in fact, two other ways to set properties of a newly instantiated object to default values.
-The first is to use the xref:rg:cms:methods/lifecycle.adoc#created[`created()`] callback, called by the framework when xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService#instantiate(...)`] or xref:rg:svc:core-domain-api/FactoryService.adoc[`FactoryService#instantiate(...)`] is called.
+The first is to use the xref:rg:cms:methods.adoc#created[`created()`] callback, called by the framework when xref:rg:svc:core-domain-api/RepositoryService.adoc[`RepositoryService#instantiate(...)`] or xref:rg:svc:core-domain-api/FactoryService.adoc[`FactoryService#instantiate(...)`] is called.
This method is called after any services have been injected into the domain object.
The second is more straightforward: simply initialize properties in the constructor.
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/get.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/get.adoc
index 951eee1..f2ec208 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/get.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/get.adoc
@@ -14,5 +14,5 @@ All remaining `public` methods (that do not use one of the Apache Isis prefixes)
Any methods "left over" that _do_ use one of the Apache Isis prefixes, are interpreted to be orphaned. Apache Isis "fails-fast" and will not boot, instead printing an error message to the log so that the issue can be easily diagnosed.
-See also xref:rg:cms:methods/prefixes.adoc#set[`set...()`].
+See also xref:rg:cms:methods.adoc#set[`set...()`].
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/hide.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/hide.adoc
index c816f0d..36c6b91 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/hide.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/hide.adoc
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
The `hide...()` supporting method is called for properties, collections, actions and action parameters.
It allows the property/collection to be completely hidden from view.
-It's comparatively rare for properties or collections to be imperatively hidden from view, but actions are sometimes hidden or shown visible (as opposed to being just xref:rg:cms:methods/prefixes.adoc#disable[disabled], ie greyed out).
+It's comparatively rare for properties or collections to be imperatively hidden from view, but actions are sometimes hidden or shown visible (as opposed to being just xref:rg:cms:methods.adoc#disable[disabled], ie greyed out).
The signature of the supporting method is simply:
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/modify.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/modify.adoc
index 63a286f..33eda13 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/modify.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/modify.adoc
@@ -37,6 +37,6 @@ public class LibraryMember {
<3> perform some additional business logic
-See also xref:rg:cms:methods/prefixes.adoc#clear[`clear...()`]`
+See also xref:rg:cms:methods.adoc#clear[`clear...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/removeFrom.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/removeFrom.adoc
index e4f0f1e..45492c1 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/removeFrom.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/removeFrom.adoc
@@ -33,4 +33,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`]`
+See also xref:rg:cms:methods.adoc#addTo[`addTo...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/set.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/set.adoc
index c357dbe..e4459ff 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/set.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/set.adoc
@@ -9,4 +9,4 @@ include::_attributes.adoc[]
The `set...()` prefix is simply the normal JavaBean setter prefix that denotes writeable properties or collections.
-See also xref:rg:cms:methods/prefixes.adoc#get[`get...()`].
+See also xref:rg:cms:methods.adoc#get[`get...()`].
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateAddTo.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateAddTo.adoc
index 3a77e8a..ae17c54 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateAddTo.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateAddTo.adoc
@@ -41,5 +41,5 @@ public class LibraryMember {
----
-See also xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`] and xref:rg:cms:methods/prefixes.adoc#validateRemoveFrom[`validateRemoveFrom...()`]`
+See also xref:rg:cms:methods.adoc#addTo[`addTo...()`] and xref:rg:cms:methods.adoc#validateRemoveFrom[`validateRemoveFrom...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateRemoveFrom.adoc b/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateRemoveFrom.adoc
index f324cc5..18b7e75 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateRemoveFrom.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/prefixes/validateRemoveFrom.adoc
@@ -41,5 +41,5 @@ public class LibraryMember {
----
-See also xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`] and xref:rg:cms:methods/prefixes.adoc#validateAddTo[`validateAddTo...()`]`
+See also xref:rg:cms:methods.adoc#removeFrom[`removeFrom...()`] and xref:rg:cms:methods.adoc#validateAddTo[`validateAddTo...()`]`
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved.adoc
index b94b7c3..35b11f8 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved.adoc
@@ -1,7 +1,7 @@
= Reserved Methods
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The table below lists the reserved methods that are recognized as part of Apache Isis' default programming model.
@@ -13,29 +13,29 @@ The table below lists the reserved methods that are recognized as part of Apache
|Method
|Description
-|xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`]
+|xref:rg:cms:methods.adoc#cssClass[`cssClass()`]
|Provides a CSS class for this object instance.
In conjunction with xref:rg:cfg:application-specific/application-css.adoc[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered.
-|xref:rg:cms:methods/reserved.adoc#disable[`disable(...)`]
+|xref:rg:cms:methods.adoc#disable[`disable(...)`]
|Disable all or some of an object's properties
-|xref:rg:cms:methods/reserved.adoc#getId[`getId()`]
+|xref:rg:cms:methods.adoc#getId[`getId()`]
|Provides an optional unique identifier of a service.
If not provided, the service's fully-qualified class name is used.
-|xref:rg:cms:methods/reserved.adoc#hide[`hide(...)`]
+|xref:rg:cms:methods.adoc#reserved-hide[`hide(...)`]
|Hide all or some of an object's properties
-|xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`]
+|xref:rg:cms:methods.adoc#iconName[`iconName()`]
|Provides the name of the image to render, usually alongside the title, to represent the object.
If not provided, then the class name is used to locate an image.
-|xref:rg:cms:methods/reserved.adoc#title[`title()`]
+|xref:rg:cms:methods.adoc#title[`title()`]
|Provides a title for the object. +
-|xref:rg:cms:methods/reserved.adoc#validate[`validate()`]
+|xref:rg:cms:methods.adoc#reserved-validate[`validate()`]
|Validate the object's state prior to persisting.
|===
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/cssClass.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/cssClass.adoc
index 55c69cf..639adc7 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/cssClass.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/cssClass.adoc
@@ -48,6 +48,6 @@ tr.done {
See also:
-* xref:rg:cms:methods/reserved.adoc#title[`title()`]
-* xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`]
-* xref:rg:cms:methods/reserved.adoc#layout[`layout()`]
+* xref:rg:cms:methods.adoc#title[`title()`]
+* xref:rg:cms:methods.adoc#iconName[`iconName()`]
+* xref:rg:cms:methods.adoc#layout[`layout()`]
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/disable.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/disable.adoc
index d8cbe2a..0e8b93d 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/disable.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/disable.adoc
@@ -1,4 +1,4 @@
-[[disable]]
+[[reserved-disable]]
= `disabled()`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
One use case that Apache Isis supports is that of a domain object with a lifecycle whereby at some stage it should become immutable: all its properties/collections should be disabled, and/or its actions become not invokable.
-It would be painful to have to write a separate xref:rg:cms:methods/prefixes.adoc#disable[`disable...()`] method for each and every member, so instead Isis allows a single `disable...(...)` method to be implemented that is applied to all members.
+It would be painful to have to write a separate xref:rg:cms:methods.adoc#reserved-disable[`disable...()`] method for each and every member, so instead Isis allows a single `disable...(...)` method to be implemented that is applied to all members.
The signature of the method is:
@@ -30,7 +30,7 @@ public String disabled(Identifier.Type identifierType) {
}
----
-See also the similar methods to xref:rg:cms:methods/reserved.adoc#hide[`hide()`] object members en-masse.
+See also the similar methods to xref:rg:cms:methods.adoc#hide[`hide()`] object members en-masse.
== Alternatives
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/getId.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/getId.adoc
index 70f7ea4..8b0fab5 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/getId.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/getId.adoc
@@ -11,7 +11,7 @@ This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
(see xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`])
-* in the serialization of `OidDto` in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas
+* in the serialization of `OidDto` in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas
* in the URLs of the xref:vro:ROOT:about.adoc[RestfulObjects viewer]
* in the URLs of the xref:vw:ROOT:about.adoc[Wicket viewer] (specifically, for bookmarked actions)
@@ -37,7 +37,7 @@ public class OrderMenu {
The rules of precedence are:
1. xref:rg:ant:DomainService.adoc#objectType[`@DomainService#objectType()`]
-2. xref:rg:cms:methods/reserved.adoc#getId[`getId()`]
+2. xref:rg:cms:methods.adoc#getId[`getId()`]
3. The fully qualified class name.
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/hide.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/hide.adoc
index b0cb72f..fa2ef6d 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/hide.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/hide.adoc
@@ -1,4 +1,4 @@
-[[hide]]
+[[reserved-hide]]
= `hide()`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
One use case that Apache Isis supports is that of a domain object with a lifecycle whereby at some stage some number of the object's members should be hidden.
For example, for an object that at some stage is logically immutable, we might want to make all its properties/collections unmodifiable and hide all its actions.
-While we could write a separate xref:rg:cms:methods/prefixes.adoc#hide[`hide...()`] method for each and every action, this could become painful. So instead Isis allows a single `hide...(...)` method to be implemented that is applied to all members.
+While we could write a separate xref:rg:cms:methods.adoc#hide[`hide...()`] method for each and every action, this could become painful. So instead Isis allows a single `hide...(...)` method to be implemented that is applied to all members.
The signature of the method is:
@@ -28,12 +28,12 @@ public boolean hide(Identifier.Type identifierType) {
}
----
-See also the similar method to xref:rg:cms:methods/reserved.adoc#disable[`disable()`] object members en-masse.
+See also the similar method to xref:rg:cms:methods.adoc#disable[`disable()`] object members en-masse.
== Alternatives
An alternative design -- and one that could be easily argued is actually more flexible -- is to leverage domain events with vetoing subscribers.
-There is further discussion on this approach in xref:rg:cms:methods/reserved.adoc#disable[here].
+There is further discussion on this approach in xref:rg:cms:methods.adoc#disable[here].
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/iconName.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/iconName.adoc
index 4a3bd3d..29e2f44 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/iconName.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/iconName.adoc
@@ -41,7 +41,7 @@ public class ToDoItem ... {
See also:
-* xref:rg:cms:methods/reserved.adoc#title[`title()`]
-* xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`]
-* xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`]
-* xref:rg:cms:methods/reserved.adoc#layout[`layout()`]
+* xref:rg:cms:methods.adoc#title[`title()`]
+* xref:rg:cms:methods.adoc#iconName[`iconName()`]
+* xref:rg:cms:methods.adoc#cssClass[`cssClass()`]
+* xref:rg:cms:methods.adoc#layout[`layout()`]
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/layout.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/layout.adoc
index c16d338..d1f3536 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/layout.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/layout.adoc
@@ -42,6 +42,6 @@ If `switchToEditMode()` action is invoked, then the UI will attempt to render th
See also:
-* xref:rg:cms:methods/reserved.adoc#title[`title()`]
-* xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`]
-* xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`]
+* xref:rg:cms:methods.adoc#title[`title()`]
+* xref:rg:cms:methods.adoc#iconName[`iconName()`]
+* xref:rg:cms:methods.adoc#cssClass[`cssClass()`]
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/title.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/title.adoc
index d0a6fe1..311892e 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/title.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/title.adoc
@@ -43,7 +43,7 @@ public String title() {
return buf.toString();
}
----
-<1> simple xref:rg:cms:classes/utility.adoc#TitleBuffer[utility class] to help construct the title string
+<1> simple xref:rg:cms:classes.adoc#TitleBuffer[utility class] to help construct the title string
<2> imperative conditional logic
<3> using the xref:rg:svc:application-layer-api/WrapperFactory.adoc[`WrapperFactory`] to determine if the `dueBy` field is visible for this user ...
<4> ... but ignore if not
@@ -59,7 +59,7 @@ In many cases, though, you may be able to use the xref:rg:ant:Title.adoc[`@Title
See also:
-* xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`]
-* xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`]
-* xref:rg:cms:methods/reserved.adoc#layout[`layout()`]
+* xref:rg:cms:methods.adoc#iconName[`iconName()`]
+* xref:rg:cms:methods.adoc#cssClass[`cssClass()`]
+* xref:rg:cms:methods.adoc#layout[`layout()`]
diff --git a/core/_adoc-rg/modules/cms/pages/methods/reserved/validate.adoc b/core/_adoc-rg/modules/cms/pages/methods/reserved/validate.adoc
index f95ca88..8d4d1fe 100644
--- a/core/_adoc-rg/modules/cms/pages/methods/reserved/validate.adoc
+++ b/core/_adoc-rg/modules/cms/pages/methods/reserved/validate.adoc
@@ -1,4 +1,4 @@
-[[validate]]
+[[reserved-validate]]
= `validate()`
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
diff --git a/core/_adoc-rg/modules/cms/pages/schema.adoc b/core/_adoc-rg/modules/cms/pages/schema.adoc
index e8f5f43..51903df 100644
--- a/core/_adoc-rg/modules/cms/pages/schema.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema.adoc
@@ -7,17 +7,17 @@ Most applications need to integrate with other apps in the enterprise. To facil
Apache Isis defines a number of standard XSD schemas:
-* the xref:rg:cms:schema/mml.adoc[metamodel] schema, which allows the internal metamodel to be exported in a canonical fashion
+* the xref:rg:cms:schema.adoc#mml[metamodel] schema, which allows the internal metamodel to be exported in a canonical fashion
-* the xref:rg:cms:schema/cmd.adoc[command] schema, which captures the __intention__ of a user
+* the xref:rg:cms:schema.adoc#cmd[command] schema, which captures the __intention__ of a user
to invoke an action or edit a property
-* the xref:rg:cms:schema/ixn.adoc[interaction execution] schema, which captures the actual execution of an action invocation/property edit
+* the xref:rg:cms:schema.adoc#ixn[interaction execution] schema, which captures the actual execution of an action invocation/property edit
-* the xref:rg:cms:schema/chg.adoc[changes] schema, which captures which objects have been
+* the xref:rg:cms:schema.adoc#chg[changes] schema, which captures which objects have been
created, updated or deleted as the result of an execution of an action invocation/property edit
-These each use XSD types defined by the xref:rg:cms:schema/common.adoc[common schema] (most notably the `oidDto`
+These each use XSD types defined by the xref:rg:cms:schema.adoc#common[common schema] (most notably the `oidDto`
complex type which identifies a domain object).
The (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command and publishmq modules use these schemas to reify
@@ -25,3 +25,10 @@ corresponding applib objects (`Command`, `Interaction.Execution` and `PublishedO
The sections below discuss these schemas in more detail.
+
+//include::schema/aim.adoc[leveloffset=+1] // replaced in 1.13.0
+include::schema/mml.adoc[leveloffset=+1]
+include::schema/cmd.adoc[leveloffset=+1]
+include::schema/ixn.adoc[leveloffset=+1]
+include::schema/chg.adoc[leveloffset=+1]
+include::schema/common.adoc[leveloffset=+1]
diff --git a/core/_adoc-rg/modules/cms/pages/schema/aim.adoc b/core/_adoc-rg/modules/cms/pages/schema/aim.adoc
index 00d9178..1b6d486 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/aim.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/aim.adoc
@@ -2,19 +2,19 @@
= Action Invocation Memento
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The "aim" schema previously defined the serialized form (or memento) of an action invocation.
The schema was removed in `1.13.0`, and was replaced by:
-* xref:rg:cms:schema/ixn.adoc[ixn.xsd]
+* xref:rg:cms:schema.adoc#ixn[ixn.xsd]
+
for action invocations/property edits, and
-* xref:rg:cms:schema/cmd.adoc[cmd.xsd]
+* xref:rg:cms:schema.adoc#cmd[cmd.xsd]
+
for commands, ie the __intention__ to invoke an action/edit a property.
diff --git a/core/_adoc-rg/modules/cms/pages/schema/chg.adoc b/core/_adoc-rg/modules/cms/pages/schema/chg.adoc
index 40af741..62991c3 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/chg.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/chg.adoc
@@ -2,7 +2,7 @@
= Changes
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The changes ("chg") schema defines the serialized form identifying which objects have been created, updated or deleted as the result of invoking an action or editing a property.
@@ -48,12 +48,12 @@ The `changesDto` root element is defined as:
----
<1> the changes schema has a namespace URI of "http://isis.apache.org/schema/chg".
Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.
-<2> uses complex types defined in the xref:rg:cms:schema/common.adoc["common" schema].
+<2> uses complex types defined in the xref:rg:cms:schema.adoc#common["common" schema].
<3> definition of the `changesDto` root element.
The corresponding XML will use this as its top-level element.
<4> each instance of this schema indicates the version of the schema it is compatible with (following semantic versioning)
<5> unique identifier for the transaction in which this interaction is being executed.
-The transaction Id is used to correlate back to the xref:rg:cms:schema/command.adoc[command] that represented the intention to perform this execution, as well as to the xref:rg:cms:schema/interaction.adoc[interaction] that executes said command.
+The transaction Id is used to correlate back to the xref:rg:cms:schema.adoc#command[command] that represented the intention to perform this execution, as well as to the xref:rg:cms:schema.adoc#interaction[interaction] that executes said command.
<6> uniquely identifies this set of changes within the interaction.
Can be combined with `transactionId` to create a unique identifier (across all other changed object events and also any interaction executions) of this particular set of changed objects.
<7> the date/time that the transaction that dirtied this objects completed
@@ -88,4 +88,4 @@ It also captures additional metrics counters:
<2> the identities of the objects that were, respectively, created, updated or deleted within the transaction.
<3> the number of objects' properties changed, in total, by the interaction.
-The xref:rg:cms:schema/ixn.adoc[interaction] schema also provides metrics on the number of objects loaded/changed, but is more granular, each figure relating to a single (sub-)execution within an interaction.
+The xref:rg:cms:schema.adoc#ixn[interaction] schema also provides metrics on the number of objects loaded/changed, but is more granular, each figure relating to a single (sub-)execution within an interaction.
diff --git a/core/_adoc-rg/modules/cms/pages/schema/cmd.adoc b/core/_adoc-rg/modules/cms/pages/schema/cmd.adoc
index c86eb6b..7c130c8 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/cmd.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/cmd.adoc
@@ -2,7 +2,7 @@
= Command
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The command ("cmd") schema defines the serialized form of the __intention__ to invoke an action or to edit a property.
It can be supplemented with optional timings capturing the actual invocation of a command (introduced to support the replication of commands in a master/slave arrangement).
@@ -62,12 +62,12 @@ The `commandDto` root element is defined as:
----
<1> the command schema has a namespace URI of "http://isis.apache.org/schema/cmd".
Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.
-<2> uses complex types defined in the xref:rg:cms:schema/common.adoc["common" schema].
+<2> uses complex types defined in the xref:rg:cms:schema.adoc#common["common" schema].
<3> definition of the `commandDto` root element.
The corresponding XML will use this as its top-level element.
<4> each instance of this schema indicates the version of the schema it is compatible with (following semantic versioning)
<5> unique identifier for the transaction in which this command is created.
-The transaction Id is used to correlate to the xref:rg:cms:schema/interaction.adoc[interaction] that executes the command, and to any xref:rg:cms:schema/changes.adoc[changes] to domain objects occurring as a side-effect of that interaction.
+The transaction Id is used to correlate to the xref:rg:cms:schema.adoc#interaction[interaction] that executes the command, and to any xref:rg:cms:schema.adoc#changes[changes] to domain objects occurring as a side-effect of that interaction.
<6> the name of the user who created the command (whose intention it is to invoke the action/edit the property).
<7> the target object (or objects) to be invoked.
A bulk action will create multiple commands, each with only a single target.
@@ -127,12 +127,12 @@ Its primary responsibility is simply to identify the member (action or property)
<3> the "logical" formal identifier (object type, as per `@DomainObject(objectType=)`, + member name) of the member being interacted with (action or property).
<4> the `interactionType` attribute indicates whether the member is an action or a property.
<5> the `actionDto` complex type captures the set of parameters (also including the argument values) with which to invoke the action.
-The `paramsDto` type is defined xref:rg:cms:schema/cmd/ancillary.adoc[below].
+The `paramsDto` type is defined xref:rg:cms:schema.adoc#cmd/ancillary[below].
<6> the `propertyDto` complex type captures the new value (possibly `null`) to set the property to.
In general the `logicalMemberIdentifier` should be used in preference to the `memberIdentifier` because will not (necessarily) have to change if the class is moved during a refactoring.
-Note also that there is a corresponding xref:rg:cms:schema/ixn/memberExecutionDto.adoc[`memberExecutionDto`]
+Note also that there is a corresponding xref:rg:cms:schema.adoc#ixn/memberExecutionDto[`memberExecutionDto`]
complex type in the "ixn" schema that is for the actual execution (capturing metrics about its execution and also the return value if an action invocation).
@@ -163,4 +163,4 @@ The schema also defines a small number of supporting types:
<1> the `paramsDto` is simply the list of parameter/arguments.
<2> the `paramDto` complex type essentially combines a parameter with its corresponding argument: a named value that has a type.
It extends the `valueWithTypeDto` complex type taken from the
-xref:rg:cms:schema/common.adoc["common"] schema.
+xref:rg:cms:schema.adoc#common["common"] schema.
diff --git a/core/_adoc-rg/modules/cms/pages/schema/common.adoc b/core/_adoc-rg/modules/cms/pages/schema/common.adoc
index a9f2d62..11c498e 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/common.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/common.adoc
@@ -2,7 +2,7 @@
= Common Schema
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The "common" schema defines a number of complex types that are used by other higher-level schemas.
@@ -59,7 +59,7 @@ If none is specified, then the fully qualified class name will be used.
<5> the `bookmarkObjectState` enumerates the possible persistence states of the referenced object.
In previous versions of the schema the attribute was defaulted to "persistent"; the "persistent" state is assumed if the attribute is omitted.
<6> Models a list of OIDs.
-This is used by the xref:rg:cms:schema/cmd.adoc["cmd" schema] to represent the
+This is used by the xref:rg:cms:schema.adoc#cmd["cmd" schema] to represent the
intention to perform a bulk actions (against a number of selected objects).
In previous versions of the schema the object type and object identifers of `oidDto` were modelled as an element rather than an attribute.
@@ -72,11 +72,11 @@ xref:rg:ant:XmlRootElement.adoc[`@XmlRootElement`]), that reference domain entit
+
These references are serialized instead into OIDs
-* second, as references to the target of a command representing the _intention_ to invoke an action or edit a property, as described by the xref:rg:cms:schema/cmd.adoc["cmd" (command)] schema.
+* second, as references to the target of a command representing the _intention_ to invoke an action or edit a property, as described by the xref:rg:cms:schema.adoc#cmd["cmd" (command)] schema.
+
They are also used to represent references to any action arguments/properties that take domain object entities/view models.
-* third, as references to the target of an interaction capturing the actual execution of an action invocation or property edit, as described by the xref:rg:cms:schema/ixn.adoc["ixn" (interaction)] schema.
+* third, as references to the target of an interaction capturing the actual execution of an action invocation or property edit, as described by the xref:rg:cms:schema.adoc#ixn["ixn" (interaction)] schema.
== `collectionDto` etc
@@ -170,7 +170,7 @@ This is primarily to save storage space if the resultant XML is persisted as a m
== Ancillary types
-The common schema also defines a number of ancillary types, used either by the common schema itself (see above) or by the xref:rg:cms:schema/cmd.adoc["cmd"] and xref:rg:cms:schema/ixn.adoc["ixn"] schemas.
+The common schema also defines a number of ancillary types, used either by the common schema itself (see above) or by the xref:rg:cms:schema.adoc#cmd["cmd"] and xref:rg:cms:schema.adoc#ixn["ixn"] schemas.
[source,xml]
----
@@ -239,6 +239,6 @@ The common schema also defines a number of ancillary types, used either by the c
<5> Captures a pair of numbers representing a difference.
Used for example to capture metrics (number objects modified before and after).
<6> Whether this command/interaction with a member is invoking an action, or editing a property.
-Used by both the xref:rg:cms:schema/cmd.adoc["cmd"] and xref:rg:cms:schema/ixn.adoc["ixn"] schemas.
+Used by both the xref:rg:cms:schema.adoc#cmd["cmd"] and xref:rg:cms:schema.adoc#ixn["ixn"] schemas.
<7> Contains a list of OIDs, eg for use in "bulk" actions that apply to multiple targets.
diff --git a/core/_adoc-rg/modules/cms/pages/schema/ixn.adoc b/core/_adoc-rg/modules/cms/pages/schema/ixn.adoc
index f218970..ce8a60c 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/ixn.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/ixn.adoc
@@ -2,7 +2,7 @@
= Interaction Execution
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The interaction ("ixn") schema defines the serialized form of an action invocation or a property edit.
@@ -54,12 +54,12 @@ The `interactionDto` root element is defined as:
----
<1> the interaction schema has a namespace URI of "http://isis.apache.org/schema/ixn".
Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.
-<2> uses complex types defined in the xref:rg:cms:schema/common.adoc["common" schema] and also the xref:rg:cms:schema/cmd.adoc["cmd" schema]
+<2> uses complex types defined in the xref:rg:cms:schema.adoc#common["common" schema] and also the xref:rg:cms:schema.adoc#cmd["cmd" schema]
<3> definition of the `interactionDto` root element.
The corresponding XML will use this as its top-level element.
<4> each instance of this schema indicates the version of the schema it is compatible with (following semantic versioning)
<5> unique identifier for the transaction in which this interaction is being executed.
-The transaction Id is used to correlate back to the xref:rg:cms:schema/command.adoc[command] that represented the intention to perform this execution, as well as to any xref:rg:cms:schema/changes.adoc[changes] to domain objects that occur as a side-effect of the interaction.
+The transaction Id is used to correlate back to the xref:rg:cms:schema.adoc#command[command] that represented the intention to perform this execution, as well as to any xref:rg:cms:schema.adoc#changes[changes] to domain objects that occur as a side-effect of the interaction.
<6> the top-level `memberExecutionDto`, defined below, either an action invocation or edit of a property.
The `InteractionDto` DTO corresponding to the `interactionDto` root element can be marshalled to/from XML using the `InteractionDtoUtils` class.
@@ -69,7 +69,7 @@ The `InteractionDto` DTO corresponding to the `interactionDto` root element can
== `memberExecutionDto`
The `memberExecutionDto` complex type is an abstract type representing either the invocation an action or the editing of a property.
-It corresponds to the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`] of the "cmd" schema; some elements are copied directly:
+It corresponds to the xref:rg:cms:schema.adoc#cmd/memberDto[`memberDto`] of the "cmd" schema; some elements are copied directly:
[source,xml]
----
@@ -103,12 +103,12 @@ It corresponds to the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`] of the
<1> the `memberExecutionDto` is an abstract type
<2> uniquely identifies this execution within the transaction.
Can be combined with `transactionId` to create a unique identifier (across all other interaction executions and also changed objects events) of this particular interaction execution.
-<3> the target object, corresponding to one of the elements of the `targets` element of the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`]
-<4> the member identifier; corresponds to `memberIdentifier` of the `member` element of the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`]
-<5> the _logical_ member identifier; corresponds to `logicalMemberIdentifier` of the `member` element of the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`]
-<6> the user executing the action invocation/property edit; corresponds to the `user` element of the xref:rg:cms:schema/cmd/memberDto.adoc[`memberDto`]
+<3> the target object, corresponding to one of the elements of the `targets` element of the xref:rg:cms:schema.adoc#cmd/memberDto[`memberDto`]
+<4> the member identifier; corresponds to `memberIdentifier` of the `member` element of the xref:rg:cms:schema.adoc#cmd/memberDto[`memberDto`]
+<5> the _logical_ member identifier; corresponds to `logicalMemberIdentifier` of the `member` element of the xref:rg:cms:schema.adoc#cmd/memberDto[`memberDto`]
+<6> the user executing the action invocation/property edit; corresponds to the `user` element of the xref:rg:cms:schema.adoc#cmd/memberDto[`memberDto`]
<7> the current "human-friendly" title of the target object
-<8> the set of metrics captured for this execution, of type `metricsDto` defined xref:rg:cms:schema/ixn/ancillary.adoc[below].
+<8> the set of metrics captured for this execution, of type `metricsDto` defined xref:rg:cms:schema.adoc#ixn/ancillary[below].
<9> if the action invocation/property edit threw an exception, then this is captured here.
<10> if any sub-actions or sub-edits were performed via the xref:rg:svc:application-layer-api/WrapperFactory.adoc[`WrapperFactory`], then these are captured in the `childExecutions` element.
<11> the `interactionType` attribute indicates whether the member is an action or a property (similar attribute exists for the "cmd" schema).
@@ -149,12 +149,12 @@ The `actionInvocationDto` and `propertyEditDto` are the concrete subtypes:
----
<1> the `actionInvocationDto` inherits from `memberExecutionDto`.
It corresponds to the similar
-xref:rg:cms:schema/cmd/memberDto.adoc[`actionDto`] complex type of the "cmd" schema
+xref:rg:cms:schema.adoc#cmd/memberDto[`actionDto`] complex type of the "cmd" schema
<2> the `parameters` element captures the parameter and argument values; for the top-level execution it is a direct copy of the corresponding `parameters` element of the `actionDto` complex type of the "cmd" schema.
<3> the `returned` element captures the returned value (if not void).
It is not valid for both this element and the inherited `threw` element to both be populated.
<4> the `propertyEditDto` inherits from `memberExecutionDto`.
-It corresponds to the similar xref:rg:cms:schema/cmd/memberDto.adoc[`propertyDto`] complex type of the "cmd" schema
+It corresponds to the similar xref:rg:cms:schema.adoc#cmd/memberDto[`propertyDto`] complex type of the "cmd" schema
<5> the `newValue` element captures the new value; for the top-level execution it is a direct
copy of the corresponding `newValue` element of the `propertyDto` complex type of the "cmd" schema.
@@ -195,4 +195,4 @@ The schema also defines a small number of supporting types:
Together these metrics give an idea of the "size" of this particular execution.
<3> the `exceptionDto` complex type defines a structure for capturing the stack trace of any exception that might occur in the course of invoking an action or editing a property.
-The xref:rg:cms:schema/changes.adoc[changes] schema also provides metrics on the number of objects loaded/changed, but relates to the entire interaction rather than just one (sub)execution of an interaction.
\ No newline at end of file
+The xref:rg:cms:schema.adoc#changes[changes] schema also provides metrics on the number of objects loaded/changed, but relates to the entire interaction rather than just one (sub)execution of an interaction.
\ No newline at end of file
diff --git a/core/_adoc-rg/modules/cms/pages/schema/mml.adoc b/core/_adoc-rg/modules/cms/pages/schema/mml.adoc
index 9319409..db991aa 100644
--- a/core/_adoc-rg/modules/cms/pages/schema/mml.adoc
+++ b/core/_adoc-rg/modules/cms/pages/schema/mml.adoc
@@ -2,7 +2,7 @@
= MetaModel
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
include::_attributes.adoc[]
-
+:page-partial:
The metamodel ("mml") schema defines the serialized form of the metamodel, used by the framework to render and interact with the application's domain objects.
diff --git a/core/_adoc-rg/modules/fis/pages/application-layer/CommandDtoServiceInternal.adoc b/core/_adoc-rg/modules/fis/pages/application-layer/CommandDtoServiceInternal.adoc
index de2da6f..16390f3 100644
--- a/core/_adoc-rg/modules/fis/pages/application-layer/CommandDtoServiceInternal.adoc
+++ b/core/_adoc-rg/modules/fis/pages/application-layer/CommandDtoServiceInternal.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
The `CommandDtoServiceInternal` is responsible for creating an memento of the current action
invocation or property edit, to store in the `Command` object (from
xref:rg:svc:application-layer-api/CommandContext.adoc[`CommandContext`]). This memento is a JAXB DTO being an instance of the
-xref:rg:cms:schema/cmd.adoc["cmd" schema], so can be reified so that its execution can be deferred until later,
+xref:rg:cms:schema.adoc#cmd["cmd" schema], so can be reified so that its execution can be deferred until later,
as a xref:rg:svc:application-layer-spi/BackgroundCommandService.adoc[background command].
@@ -36,7 +36,7 @@ public interface CommandDtoServiceInternal {
final ObjectAdapter valueAdapter);
}
----
-<1> Returns a JAXB DTO being an instance of the xref:rg:cms:schema/cmd.adoc["cmd" schema] (hence convertible to
+<1> Returns a JAXB DTO being an instance of the xref:rg:cms:schema.adoc#cmd["cmd" schema] (hence convertible to
XML) that represents the __intention__ to invoke an action on a target object (or possibly many targets, for
bulk actions). If an action, it can also be either mixin action or a contributed action.
<2> Returns a JAXB DTO that represents the intention to edit (set or clear) a property on a target (or possibly many
@@ -52,4 +52,4 @@ The SPI is implemented by `o.a.i.c.r.s.command.CommandDtoServiceInternalServiceD
The design of this service is similar to that of
xref:rg:fis:application-layer/InteractionDtoServiceInternal.adoc[`InteractionDtoServiceInternal`], used to create the
-`MemberExecutionDto` (from the xref:rg:cms:schema/ixn.adoc["ixn" schema]).
+`MemberExecutionDto` (from the xref:rg:cms:schema.adoc#ixn["ixn" schema]).
diff --git a/core/_adoc-rg/modules/fis/pages/application-layer/InteractionDtoServiceInternal.adoc b/core/_adoc-rg/modules/fis/pages/application-layer/InteractionDtoServiceInternal.adoc
index 6b7e9bf..bc0b1da 100644
--- a/core/_adoc-rg/modules/fis/pages/application-layer/InteractionDtoServiceInternal.adoc
+++ b/core/_adoc-rg/modules/fis/pages/application-layer/InteractionDtoServiceInternal.adoc
@@ -4,7 +4,7 @@ include::_attributes.adoc[]
-The `InteractionDtoServiceInternal` internal domain service is used by the framework to create and update DTOs representing member executions, ie the invocation of an action or the editing of a property. The DTO is in all cases a subclass of `MemberExecutionDto`, from the xref:rg:cms:schema/ixn.adoc["ixn" schema], and subsequently accessible from the `Interaction` object (per the xref:rg:svc:application-layer-api/InteractionContext.adoc[`InteractionContext`] service).
+The `InteractionDtoServiceInternal` internal domain service is used by the framework to create and update DTOs representing member executions, ie the invocation of an action or the editing of a property. The DTO is in all cases a subclass of `MemberExecutionDto`, from the xref:rg:cms:schema.adoc#ixn["ixn" schema], and subsequently accessible from the `Interaction` object (per the xref:rg:svc:application-layer-api/InteractionContext.adoc[`InteractionContext`] service).
== SPI & Implementation
@@ -29,7 +29,7 @@ public interface InteractionDtoServiceInternal {
}
----
<1> called by the framework when invoking an action, to create a DTO capturing the details of the action invocation (target, arguments etc).
-<2> called by the framework when editing a property, to create a DTO (for the xref:rg:cms:schema/ixn.adoc["ixn" schema]) capturing the details of the property edit (target, new value etc).
+<2> called by the framework when editing a property, to create a DTO (for the xref:rg:cms:schema.adoc#ixn["ixn" schema]) capturing the details of the property edit (target, new value etc).
<3> called by the framework to attach the result of an action invocation to the aforementioned DTO.
The service is implemented by `o.a.i.core.runtime.services.ixn.InteractionDtoServiceInternalDefault`.
@@ -39,4 +39,4 @@ The service is implemented by `o.a.i.core.runtime.services.ixn.InteractionDtoSer
The design of this service is similar to that of
xref:rg:fis:application-layer/CommandDtoServiceInternal.adoc[`CommandDtoServiceInternal`], used to create the `CommandDto`
-(from the xref:rg:cms:schema/cmd.adoc["cmd" schema]).
+(from the xref:rg:cms:schema.adoc#cmd["cmd" schema]).
diff --git a/core/_adoc-rg/modules/svc/pages/application-layer-api/CommandExecutorService.adoc b/core/_adoc-rg/modules/svc/pages/application-layer-api/CommandExecutorService.adoc
index 1da5872..1579afb 100644
--- a/core/_adoc-rg/modules/svc/pages/application-layer-api/CommandExecutorService.adoc
+++ b/core/_adoc-rg/modules/svc/pages/application-layer-api/CommandExecutorService.adoc
@@ -7,7 +7,7 @@ include::_attributes.adoc[]
The `CommandExecutorService` domain service is provides the ability to execute a specified `Command`, optionally running the command with the identity of the user captured in that `Command`.
In fact, the service requires that the implementation of the `Command` being executed implements the `CommandWithDto` sub-interface.
-This allows the xref:rg:cms:schema/cmd.adoc[`CommandDto`] memento to be extracted, from which the action can be invoked/property edited.
+This allows the xref:rg:cms:schema.adoc#cmd[`CommandDto`] memento to be extracted, from which the action can be invoked/property edited.
The primary use case for this service is to allow the replay of commands, eg for regression testing.
This is implemented by the (non-ASF) link:https://platform.incode.org/modules/spi/command/spi-command-replay.html[command replay module].
diff --git a/core/_adoc-rg/modules/svc/pages/application-layer-api/DtoMappingHelper.adoc b/core/_adoc-rg/modules/svc/pages/application-layer-api/DtoMappingHelper.adoc
index d20b716..45edcf8 100644
--- a/core/_adoc-rg/modules/svc/pages/application-layer-api/DtoMappingHelper.adoc
+++ b/core/_adoc-rg/modules/svc/pages/application-layer-api/DtoMappingHelper.adoc
@@ -3,7 +3,7 @@
include::_attributes.adoc[]
-The `DtoMappingHelper` converts the domain object's internal identifier into a serializable `OidDto` for use in the xref:rg:cms:schema/cmd.adoc[command] and xref:rg:cms:schema/ixn.adoc[interaction] schemas.
+The `DtoMappingHelper` converts the domain object's internal identifier into a serializable `OidDto` for use in the xref:rg:cms:schema.adoc#cmd[command] and xref:rg:cms:schema.adoc#ixn[interaction] schemas.
== API and Usage
diff --git a/core/_adoc-rg/modules/svc/pages/application-layer-api/InteractionContext.adoc b/core/_adoc-rg/modules/svc/pages/application-layer-api/InteractionContext.adoc
index 369688b..757c268 100644
--- a/core/_adoc-rg/modules/svc/pages/application-layer-api/InteractionContext.adoc
+++ b/core/_adoc-rg/modules/svc/pages/application-layer-api/InteractionContext.adoc
@@ -125,7 +125,7 @@ turn via the xref:rg:svc:application-layer-api/WrapperFactory.adoc[`WrapperFacto
execution of this action invocation/property edit.
<8> The date/time at which this execution started/completed.
<9> The object returned by the action invocation/property edit, or the exception thrown. For `void` methods and for actions returning collections, the value will be `null`.
-<10> A DTO (instance of the xref:rg:cms:schema/ixn.adoc["ixn" schema]) being a serializable representation of this action invocation/property edit.
+<10> A DTO (instance of the xref:rg:cms:schema.adoc#ixn["ixn" schema]) being a serializable representation of this action invocation/property edit.
diff --git a/core/_adoc-rg/modules/svc/pages/application-layer-api/WrapperFactory.adoc b/core/_adoc-rg/modules/svc/pages/application-layer-api/WrapperFactory.adoc
index 335379d..5b03fd5 100644
--- a/core/_adoc-rg/modules/svc/pages/application-layer-api/WrapperFactory.adoc
+++ b/core/_adoc-rg/modules/svc/pages/application-layer-api/WrapperFactory.adoc
@@ -105,8 +105,8 @@ Similarly if an action has a `validateXxx()` method and the supplied arguments a
In addition, the following methods may also be called:
-* the xref:rg:cms:methods/reserved.adoc#title[`title()`] and `toString()` methods
-* any xref:rg:cms:methods/prefixes.adoc#default[`default...()`], xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`] or xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`] methods
+* the xref:rg:cms:methods.adoc#title[`title()`] and `toString()` methods
+* any xref:rg:cms:methods.adoc#default[`default...()`], xref:rg:cms:methods.adoc#choices[`choices...()`] or xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`] methods
An exception will be thrown if any other methods are thrown.
diff --git a/core/_adoc-rg/modules/svc/pages/application-layer-spi/BackgroundCommandService.adoc b/core/_adoc-rg/modules/svc/pages/application-layer-spi/BackgroundCommandService.adoc
index dcef334..cb0ff3b 100644
--- a/core/_adoc-rg/modules/svc/pages/application-layer-spi/BackgroundCommandService.adoc
+++ b/core/_adoc-rg/modules/svc/pages/application-layer-spi/BackgroundCommandService.adoc
@@ -29,7 +29,7 @@ public interface BackgroundCommandService2 {
}
----
-<1> an instance of a xref:rg:cms:schema/cmd.adoc[`CommandDto`] capturing the details of the action invocation or property edit to be retained (eg persisted to a database) so that it can be executed at a later time
+<1> an instance of a xref:rg:cms:schema.adoc#cmd[`CommandDto`] capturing the details of the action invocation or property edit to be retained (eg persisted to a database) so that it can be executed at a later time
<2> reference to the parent `Command` requesting the action be performed as a background command. This allows information such as the initiating user to be obtained.
diff --git a/core/_adoc-rg/modules/svc/pages/intro.adoc b/core/_adoc-rg/modules/svc/pages/intro.adoc
index 742f11c..50769b7 100644
--- a/core/_adoc-rg/modules/svc/pages/intro.adoc
+++ b/core/_adoc-rg/modules/svc/pages/intro.adoc
@@ -189,7 +189,7 @@ Note that it's possible for there to be more than one transaction per top-level
* Also at the end of each transaction, details of all changed properties are passed to any registered xref:rg:svc:persistence-layer-spi/AuditerService.adoc[`AuditerService`](s) by way of the (internal) xref:rg:fis:persistence-layer/AuditingServiceInternal.adoc[`AuditingServiceInternal`] domain service.
-Implementations of xref:rg:svc:application-layer-spi/CommandService.adoc[`CommandService`] can use the `Command#getMemento()` method to obtain a XML equivalent of that `Command`, reified using the xref:rg:cms:schema/cmd.adoc[`cmd.xsd`] schema.
+Implementations of xref:rg:svc:application-layer-spi/CommandService.adoc[`CommandService`] can use the `Command#getMemento()` method to obtain a XML equivalent of that `Command`, reified using the xref:rg:cms:schema.adoc#cmd[`cmd.xsd`] schema.
This can be converted back into a `CommandDto` using the `CommandDtoUtils` utility class (part of the applib).
Similarly, implementations of xref:rg:svc:persistence-layer-spi/PublisherService.adoc[`PublisherService`] can use the `InteractionDtoUtils` utility class to obtain a `InteractionDto` representing the interaction, either just for a single execution or for the entire call-graph.
diff --git a/core/_adoc-rg/modules/svc/pages/persistence-layer-spi/PublisherService.adoc b/core/_adoc-rg/modules/svc/pages/persistence-layer-spi/PublisherService.adoc
index 95fefa3..23edfd7 100644
--- a/core/_adoc-rg/modules/svc/pages/persistence-layer-spi/PublisherService.adoc
+++ b/core/_adoc-rg/modules/svc/pages/persistence-layer-spi/PublisherService.adoc
@@ -10,7 +10,7 @@ A typical use case is to publish onto a pub/sub bus such as link:http://activemq
An alternative use is for profiling: for each execution (action invocation/property edit) the framework captures metrics of the number of objects loaded or dirtied as the result of that execution.
If the xref:rg:svc:application-layer-api/WrapperFactory.adoc[`WrapperFactory`] is used to call other objects then the metrics are captured for each sub-execution.
-The framework provides a default implementation, `PublisherServiceLogging`, that will log these execution graphs (in XML form, per the xref:rg:cms:schema/ixn.adoc["ixn" schema]) to an SLF4J logger.
+The framework provides a default implementation, `PublisherServiceLogging`, that will log these execution graphs (in XML form, per the xref:rg:cms:schema.adoc#ixn["ixn" schema]) to an SLF4J logger.
Only actions/properties/domain objects annotated for publishing (using xref:rg:ant:Action.adoc#publishing[`@Action#publishing()`], xref:rg:ant:Property.adoc#publishing[`@Property#publishing()`] or xref:rg:ant:DomainObject.adoc#publishing[`@DomainObject#publishing()`]) are published.
@@ -30,7 +30,7 @@ public interface PublisherService {
<2> to publish a set of changed objects.
Each `Interaction.Execution` has an owning `Interaction`; this is the same object obtainable from xref:rg:svc:spi/InteractionContext.adoc[`InteractionContext`].
-Implementations that publish member executions can use `Interaction.Execution#getDto()` method to return a DTO (as per the xref:rg:cms:schema/ixn.adoc["ixn" schema]) which can be converted into a serializable XML representation using the `InteractionDtoUtils` utility class.
+Implementations that publish member executions can use `Interaction.Execution#getDto()` method to return a DTO (as per the xref:rg:cms:schema.adoc#ixn["ixn" schema]) which can be converted into a serializable XML representation using the `InteractionDtoUtils` utility class.
The XML can either serialize a single execution, or can be a "deep" serialization of an execution and all sub-executions.
The full API of `PublishedObjects` itself is:
@@ -53,7 +53,7 @@ public interface PublishedObjects extends HasTransactionId, HasUsername {
<1> inherited from `HasTransactionId`, correlates back to the unique identifier of the transaction in which these objects were changed.
<2> inherited from `HasUsername`, is the user that initiated the transaction causing these objects to change
<3> the time that this set of objects was collated (just before the completion of the transaction completes)..
-<4> returns a DTO (as per the xref:rg:cms:schema/chg.adoc["chg" schema]) which can be converted into a serializable XML representation can be obtained using the `ChangesDtoUtils` utility class.
+<4> returns a DTO (as per the xref:rg:cms:schema.adoc#chg["chg" schema]) which can be converted into a serializable XML representation can be obtained using the `ChangesDtoUtils` utility class.
<5> metrics as to the number of objects loaded, created, updated or deleted and the number of object properties modified (in other words the "size" or "weight" of the transaction).
diff --git a/core/_adoc-rg/modules/svc/pages/presentation-layer-spi/ContentMappingService.adoc b/core/_adoc-rg/modules/svc/pages/presentation-layer-spi/ContentMappingService.adoc
index 8e790f8..391da8d 100644
--- a/core/_adoc-rg/modules/svc/pages/presentation-layer-spi/ContentMappingService.adoc
+++ b/core/_adoc-rg/modules/svc/pages/presentation-layer-spi/ContentMappingService.adoc
@@ -43,7 +43,7 @@ public interface ContentMappingService {
The framework provides two implementations of this service, both in support of the xref:rg:svc:application-layer-spi/CommandService.adoc[`CommandService`] SPI.
By way of background: implementations of the SPI `CommandService` work with custom implementations of the `Command` interface, typically being persisted to a datastore.
-The `CommandWithDto` interface is a subtype of `Command` for implementations that can be reified into xref:rg:cms:schema/cmd.adoc[`CommandDto`] XML instances.
+The `CommandWithDto` interface is a subtype of `Command` for implementations that can be reified into xref:rg:cms:schema.adoc#cmd[`CommandDto`] XML instances.
One implementation that does this is the (non-ASF) link:https://platform.incode.org[Incode Platform^]'s command module.
For framework implementations of `ContentMappingService` allow domain service actions that return ``CommandDto``s (either singularly or in a list) to be converted into XML documents:
diff --git a/core/_adoc-ug/modules/btb/pages/deployment/externalized-configuration.adoc b/core/_adoc-ug/modules/btb/pages/deployment/externalized-configuration.adoc
index c6c37c6..38ab67c 100644
--- a/core/_adoc-ug/modules/btb/pages/deployment/externalized-configuration.adoc
+++ b/core/_adoc-ug/modules/btb/pages/deployment/externalized-configuration.adoc
@@ -103,6 +103,7 @@ Note that Shiro is more flexible than Apache Isis; it will read its configuratio
By default Apache Isis configures log4j to read the `logging.properties` file in the `WEB-INF` directory.
This can be overridden by setting the `log4j.properties` system property to the URL of the log4j properties file.
+[[log4j-config-tomcat]]
=== Tomcat
For example, if deploying to Tomcat7 or Tomcat8, this amounts to adding the following to the `CATALINA_OPTS` flags:
diff --git a/core/_adoc-ug/modules/btb/pages/hints-and-tips/are-you-sure.adoc b/core/_adoc-ug/modules/btb/pages/hints-and-tips/are-you-sure.adoc
index 06e44f1..9b4ebd8 100644
--- a/core/_adoc-ug/modules/btb/pages/hints-and-tips/are-you-sure.adoc
+++ b/core/_adoc-ug/modules/btb/pages/hints-and-tips/are-you-sure.adoc
@@ -72,4 +72,4 @@ public String validateDelete(boolean areYouSure) {
----
<1> invalid to return `this` (cannot render a deleted object)
-Note that the action itself does not use the boolean parameter, it is only used by the supporting xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`] method.
\ No newline at end of file
+Note that the action itself does not use the boolean parameter, it is only used by the supporting xref:rg:cms:methods.adoc#validate[`validate...()`] method.
\ No newline at end of file
diff --git a/core/_adoc-ug/modules/btb/pages/hints-and-tips/persisted-title.adoc b/core/_adoc-ug/modules/btb/pages/hints-and-tips/persisted-title.adoc
index c192e23..b00b703 100644
--- a/core/_adoc-ug/modules/btb/pages/hints-and-tips/persisted-title.adoc
+++ b/core/_adoc-ug/modules/btb/pages/hints-and-tips/persisted-title.adoc
@@ -8,7 +8,7 @@ include::_attributes.adoc[]
Normally the title of an object is not persisted to the database, rather it is recomputed automatically from underlying properties. On occasion though you might want the title to also be persisted; either to make things easier for the DBA, or for an integration scenario, or some other purpose.
-We can implement this feature by leveraging the xref:rg:cms:methods/lifecycle.adoc#jdo-api[JDO lifecycle]. In the design we discuss here we make it a responsibility of the entities to persist the title as a property, by implementing a `ObjectWithPersistedTitle` interface:
+We can implement this feature by leveraging the xref:rg:cms:methods.adoc#jdo-api[JDO lifecycle]. In the design we discuss here we make it a responsibility of the entities to persist the title as a property, by implementing a `ObjectWithPersistedTitle` interface:
[source,java]
----
diff --git a/core/_adoc-ug/modules/btb/pages/hints-and-tips/pushing-changes.adoc b/core/_adoc-ug/modules/btb/pages/hints-and-tips/pushing-changes.adoc
index 822eea9..cb84cc0 100644
--- a/core/_adoc-ug/modules/btb/pages/hints-and-tips/pushing-changes.adoc
+++ b/core/_adoc-ug/modules/btb/pages/hints-and-tips/pushing-changes.adoc
@@ -134,7 +134,7 @@ public class Department {
--
<1> maintain a count of the number of male ...
<2> ... and female employees (getters and setters omitted)
-<3> the xref:rg:cms:methods/prefixes.adoc#addTo[`addTo...()`] method increments the derived properties
-<4> the xref:rg:cms:methods/prefixes.adoc#removeFrom[`removeFrom...()`] method similarly decrements the derived properties
+<3> the xref:rg:cms:methods.adoc#addTo[`addTo...()`] method increments the derived properties
+<4> the xref:rg:cms:methods.adoc#removeFrom[`removeFrom...()`] method similarly decrements the derived properties
diff --git a/core/_adoc-ug/modules/btb/pages/i18n.adoc b/core/_adoc-ug/modules/btb/pages/i18n.adoc
index 9ac607d..f44a3a5 100644
--- a/core/_adoc-ug/modules/btb/pages/i18n.adoc
+++ b/core/_adoc-ug/modules/btb/pages/i18n.adoc
@@ -7,7 +7,7 @@ include::_attributes.adoc[]
Apache Isis' support for internationlization (i18n) allows every element of the domain model (the class names, property names, action names, parameter names and so forth) to be translated.
-It also supports translations of messages raised imperatively, by which we mean as the result of a call to `title()` to obtain an object's title, or messages resulting from any business rule violations (eg xref:rg:cms:methods/prefixes.adoc#disable[`disable...()`] or xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`], and so on.
+It also supports translations of messages raised imperatively, by which we mean as the result of a call to `title()` to obtain an object's title, or messages resulting from any business rule violations (eg xref:rg:cms:methods.adoc#disable[`disable...()`] or xref:rg:cms:methods.adoc#validate[`validate...()`], and so on.
The xref:vw:ROOT:about.adoc[Wicket viewer] (that is, its labels and messages) is also internationalized using the same mechanism.
If no translations are available, then the Wicket viewer falls back to using Wicket resource bundles.
diff --git a/core/_adoc-ug/modules/fun/pages/building-blocks/identifiers/oid.adoc b/core/_adoc-ug/modules/fun/pages/building-blocks/identifiers/oid.adoc
index 598ef1c..c77e79e 100644
--- a/core/_adoc-ug/modules/fun/pages/building-blocks/identifiers/oid.adoc
+++ b/core/_adoc-ug/modules/fun/pages/building-blocks/identifiers/oid.adoc
@@ -38,6 +38,6 @@ These are represented as ``Bookmark``s, obtained from the xref:rg:svc:integratio
Deep links meanwhile can be obtained from the xref:rg:svc:presentation-layer-api/DeepLinkService.adoc[``DeepLinkService`].
OIDs can also be converted into XML format, useful for integration scenarios.
-The xref:rg:cms:schema/common.adoc[common schema] XSD defines the `oidDto` complex type for precisely this purpose.
+The xref:rg:cms:schema.adoc#common[common schema] XSD defines the `oidDto` complex type for precisely this purpose.
diff --git a/core/_adoc-ug/modules/fun/pages/business-rules/side-effects.adoc b/core/_adoc-ug/modules/fun/pages/business-rules/side-effects.adoc
index 1958133..d52bbc0 100644
--- a/core/_adoc-ug/modules/fun/pages/business-rules/side-effects.adoc
+++ b/core/_adoc-ug/modules/fun/pages/business-rules/side-effects.adoc
@@ -46,6 +46,6 @@ Datanucleus does _not_ call the setter when reloading the object from the databa
[NOTE]
====
-The framework also allows side-effect code to be placed in separate xref:rg:cms:methods/prefixes.adoc#modify[`modify...()`], xref:rg:cms:methods/prefixes.adoc#clear[`clear...()`] supporting methods; if present then these will be called by the framework rather than the setter.
+The framework also allows side-effect code to be placed in separate xref:rg:cms:methods.adoc#modify[`modify...()`], xref:rg:cms:methods.adoc#clear[`clear...()`] supporting methods; if present then these will be called by the framework rather than the setter.
However, because of DataNucleus' smart handling of setters, these supporting methods are in essence redundant, and so should be considered deprecated.
====
diff --git a/core/_adoc-ug/modules/fun/pages/business-rules/usability.adoc b/core/_adoc-ug/modules/fun/pages/business-rules/usability.adoc
index 3457295..8082aa6 100644
--- a/core/_adoc-ug/modules/fun/pages/business-rules/usability.adoc
+++ b/core/_adoc-ug/modules/fun/pages/business-rules/usability.adoc
@@ -75,7 +75,7 @@ public String disable1Categorize(Category category) {
== For more information
-For more information, see xref:rg:cms:methods/prefixes.adoc#disable[`disable...()`] section in the appropriate reference guide.
+For more information, see xref:rg:cms:methods.adoc#disable[`disable...()`] section in the appropriate reference guide.
It is also possible to hide an action parameter, based on the value of some other earlier parameter:
diff --git a/core/_adoc-ug/modules/fun/pages/business-rules/validity.adoc b/core/_adoc-ug/modules/fun/pages/business-rules/validity.adoc
index 360bb53..b75830c 100644
--- a/core/_adoc-ug/modules/fun/pages/business-rules/validity.adoc
+++ b/core/_adoc-ug/modules/fun/pages/business-rules/validity.adoc
@@ -43,7 +43,7 @@ It is also possible to return a localized string by returning a `TranslatableStr
== For more information
-For more information, see the xref:rg:cms:methods/prefixes.adoc#validate[`validate...()`] section in the appropriate reference guide.
+For more information, see the xref:rg:cms:methods.adoc#validate[`validate...()`] section in the appropriate reference guide.
The reference guide also explains how to define validation declaratively, using the xref:rg:ant:Parameter.adoc#mustSatisfy[`@Parameter#mustSatisfy()`] or xref:rg:ant:Property.adoc#mustSatisfy[`@Property#mustSatisfy()`] attributes.
diff --git a/core/_adoc-ug/modules/fun/pages/business-rules/visibility.adoc b/core/_adoc-ug/modules/fun/pages/business-rules/visibility.adoc
index 950ba79..3bf30d6 100644
--- a/core/_adoc-ug/modules/fun/pages/business-rules/visibility.adoc
+++ b/core/_adoc-ug/modules/fun/pages/business-rules/visibility.adoc
@@ -62,7 +62,7 @@ However, if they check the first boolean parameter (ie, to ship the `Order` to t
== For more information
-For more information, see the xref:rg:cms:methods/prefixes.adoc#hide[`hide...()`] section in the appropriate reference guide.
+For more information, see the xref:rg:cms:methods.adoc#hide[`hide...()`] section in the appropriate reference guide.
diff --git a/core/_adoc-ug/modules/fun/pages/drop-downs-and-defaults.adoc b/core/_adoc-ug/modules/fun/pages/drop-downs-and-defaults.adoc
index 9daade4..398643a 100644
--- a/core/_adoc-ug/modules/fun/pages/drop-downs-and-defaults.adoc
+++ b/core/_adoc-ug/modules/fun/pages/drop-downs-and-defaults.adoc
@@ -7,16 +7,16 @@ include::_attributes.adoc[]
Invoking an action whose parameters are primitives or values (int, date, string etc) is simple: the user can just type in or use a date picker.
Invoking an action with a parameter of reference type (such as `Customer` or `Order`) requires the viewer to provide some mechanism by which the end-user can select the relevant instance.
-If the list of available options is fixed then the developer can provided a list a xref:rg:cms:methods/prefixes.adoc#choices[`choices...()`] supporting method (for either and action parameter or when editing a property).
+If the list of available options is fixed then the developer can provided a list a xref:rg:cms:methods.adoc#choices[`choices...()`] supporting method (for either and action parameter or when editing a property).
These are rendered in a drop-down.
-If the list of available options is much larger, then the developer can use an xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete...()`] supporting method.
+If the list of available options is much larger, then the developer can use an xref:rg:cms:methods.adoc#autoComplete[`autoComplete...()`] supporting method.
The user user enters a few characters and this is used to search for matching reference(s), again rendered in a drop-down.
Similarly, when invoking an action, there may well be suitable defaults for the action arguments.
For example, if placing an `Order` then -- even if the `Product` argument might not have a sensible default -- the quantity argument could reasonably be defaulted to 1.
Or, the `Product` might indeed have a default, say the product previously placed by this user.
-The developer indicates this using a xref:rg:cms:methods/prefixes.adoc#default[`default...()`] supporting method.
+The developer indicates this using a xref:rg:cms:methods.adoc#default[`default...()`] supporting method.
== Choices and Default
diff --git a/core/_adoc-ug/modules/fun/pages/programming-model/actions.adoc b/core/_adoc-ug/modules/fun/pages/programming-model/actions.adoc
index ba77c11..c8020e0 100644
--- a/core/_adoc-ug/modules/fun/pages/programming-model/actions.adoc
+++ b/core/_adoc-ug/modules/fun/pages/programming-model/actions.adoc
@@ -56,7 +56,7 @@ If the xref:rg:cfg:configuring-core.adoc#policy[`isis.reflector.explicitAnnotati
Parameter types can be value types or reference types.
In the case of primitive types, the end-user can just enter the value directly through the parameter field.
In the case of reference types however (such as `Product`), a drop-down must be provided from which the end-user to select.
-This is done using either a supporting xref:rg:cms:methods/prefixes.adoc#choices[`choices`] or xref:rg:cms:methods/prefixes.adoc#autoComplete[`autoComplete`] method.
+This is done using either a supporting xref:rg:cms:methods.adoc#choices[`choices`] or xref:rg:cms:methods.adoc#autoComplete[`autoComplete`] method.
The "choices" is used when there is a limited set of options, while "autoComplete" is used when there are large set of options such that the end-user must provide some characters to use for a search.
For example, the `addToBasket(...)` action shown above might well have an autocomplete supporting method :
diff --git a/core/_adoc-ug/modules/fun/pages/programming-model/view-models/dto/dto-consumers.adoc b/core/_adoc-ug/modules/fun/pages/programming-model/view-models/dto/dto-consumers.adoc
index 668546b..6b30598 100644
--- a/core/_adoc-ug/modules/fun/pages/programming-model/view-models/dto/dto-consumers.adoc
+++ b/core/_adoc-ug/modules/fun/pages/programming-model/view-models/dto/dto-consumers.adoc
@@ -22,7 +22,7 @@ In our case we focus on the validation (to determine the nature of the inbound m
====
The (non-ASF) link:https://platform.incode.org[Incode Platform^]'s publishmq module provides an out-of-the-box solution of this design.
-It provides an implementation of the xref:rg:svc:persistence-layer-spi/PublisherService.adoc[`PublisherService`], but which simply publishes instances of xref:rg:cms:schema/ixn.adoc[`InteractionDto`] to an ActiveMQ queue.
+It provides an implementation of the xref:rg:svc:persistence-layer-spi/PublisherService.adoc[`PublisherService`], but which simply publishes instances of xref:rg:cms:schema.adoc#ixn[`InteractionDto`] to an ActiveMQ queue.
Camel (or similar) can then be hooked up to consume these events from this queue, and use a processor to parse the action memento to determine what has changed on the source system.
Thereafter, a subsequent Camel processor can then call back to the source - via the xref:vro:ROOT:about.adoc[Restful Objects viewer] - to enrich the message with additional details using a DTO.
diff --git a/core/_adoc-ug/modules/fun/pages/programming-model/view-models/jaxb/referencing-domain-entities.adoc b/core/_adoc-ug/modules/fun/pages/programming-model/view-models/jaxb/referencing-domain-entities.adoc
index 1857f73..4fed366 100644
--- a/core/_adoc-ug/modules/fun/pages/programming-model/view-models/jaxb/referencing-domain-entities.adoc
+++ b/core/_adoc-ug/modules/fun/pages/programming-model/view-models/jaxb/referencing-domain-entities.adoc
@@ -8,7 +8,7 @@ It's quite common for view models to be "backed by" (be projections of) some und
For example, the `CompareCustomers` view model described xref:ug:fun:programming-model.adoc#jaxb[above] actually references two underlying ``Customer`` entities.
It wouldn't make sense to serialize out the state of a persistent entity.
-However, the identity of the underlying entity is well defined; Apache Isis defines the xref:rg:cms:schema/common.adoc[common schema] which defines the `<oid-dto>` element (and corresponding `OidDto` class): the object's type and its identifier.
+However, the identity of the underlying entity is well defined; Apache Isis defines the xref:rg:cms:schema.adoc#common[common schema] which defines the `<oid-dto>` element (and corresponding `OidDto` class): the object's type and its identifier.
This is basically a formal XML equivalent to the `Bookmark` object obtained from the xref:rg:svc:integration-api/BookmarkService.adoc[`BookmarkService`].
There is only one requirement to make this work: every referenced domain entity must be annotated with xref:rg:ant:XmlJavaTypeAdapter.adoc[`@XmlJavaTypeAdapter`], specifying the framework-provided `PersistentEntityAdapter`.
diff --git a/core/_adoc-ug/modules/fun/pages/ui-hints/object-titles-and-icons.adoc b/core/_adoc-ug/modules/fun/pages/ui-hints/object-titles-and-icons.adoc
index da96975..5640db2 100644
--- a/core/_adoc-ug/modules/fun/pages/ui-hints/object-titles-and-icons.adoc
+++ b/core/_adoc-ug/modules/fun/pages/ui-hints/object-titles-and-icons.adoc
@@ -88,7 +88,7 @@ could return "Arthur C. Clarke".
=== Imperative style
-Alternatively, the title can be provided simply by implementing the xref:rg:cms:methods/reserved.adoc#title[`title()`] reserved method.
+Alternatively, the title can be provided simply by implementing the xref:rg:cms:methods.adoc#title[`title()`] reserved method.
For example:
@@ -191,7 +191,7 @@ public class InvoiceRun {
=== Imperative style
-To customise the icon on an instance-by-instance basis, we implement the reserved xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] method.
+To customise the icon on an instance-by-instance basis, we implement the reserved xref:rg:cms:methods.adoc#iconName[`iconName()`] method.
For example:
@@ -257,7 +257,7 @@ public class OrderSubscriptions extends AbstractSubscriber {
== Object CSS Styling
-It is also possible for an object to return a xref:rg:cms:methods/reserved.adoc#cssClass[CSS class].
+It is also possible for an object to return a xref:rg:cms:methods.adoc#cssClass[CSS class].
In conjunction with xref:vw:ROOT:customisation/tweaking-css-classes.adoc[customized CSS] this can be used to apply arbitrary styling; for example each object could be rendered in a page with a different background colour.
@@ -277,7 +277,7 @@ One possible use case would be to render the most important object types with a
=== Imperative style
-To customise the icon on an instance-by-instance basis, we implement the reserved xref:rg:cms:methods/reserved.adoc#cssClass[`cssClass()`] method.
+To customise the icon on an instance-by-instance basis, we implement the reserved xref:rg:cms:methods.adoc#cssClass[`cssClass()`] method.
For example:
diff --git a/core/testsupport/_adoc/modules/mvn/pages/intro.adoc b/core/testsupport/_adoc/modules/mvn/pages/intro.adoc
index 57b06f7..39662db 100644
--- a/core/testsupport/_adoc/modules/mvn/pages/intro.adoc
+++ b/core/testsupport/_adoc/modules/mvn/pages/intro.adoc
@@ -18,7 +18,7 @@ Uses the xref:rg:svc:metadata-api/SwaggerService.adoc[`SwaggerService`] to gener
+
Uses the xref:rg:svc:integration-api/JaxbService.adoc[`JaxbService`] to generate XSD schemas from any JAXB-annotated view models/DTOs. +
+
-This is instead of and preferable to using the JAXB link:https://jaxb.java.net/2.2.4/docs/schemagen.html[schemagen] tool, because it uses the framework's support (via xref:rg:ant:XmlJavaTypeAdapter.adoc[`@XmlJavaTypeAdapter`]) to translate any references to domain objects into ``OidDto``s (as defined by the Apache Isis xref:rg:cms:schema/common.adoc[common schema]).
+This is instead of and preferable to using the JAXB link:https://jaxb.java.net/2.2.4/docs/schemagen.html[schemagen] tool, because it uses the framework's support (via xref:rg:ant:XmlJavaTypeAdapter.adoc[`@XmlJavaTypeAdapter`]) to translate any references to domain objects into ``OidDto``s (as defined by the Apache Isis xref:rg:cms:schema.adoc#common[common schema]).
The `validate` goal is by default bound to the `test` phase, and the `swagger` goal is by default bound to the `package` phase; both are typically of your application's `dom` sub-module.
The `xsd` goal meanwhile defaults to the `generate-resources` phase, and this is generally used in a completely separate sub-module.
diff --git a/core/testsupport/_adoc/modules/mvn/pages/xsd.adoc b/core/testsupport/_adoc/modules/mvn/pages/xsd.adoc
index 075a042..8572aaa 100644
--- a/core/testsupport/_adoc/modules/mvn/pages/xsd.adoc
+++ b/core/testsupport/_adoc/modules/mvn/pages/xsd.adoc
@@ -10,7 +10,7 @@ generate XSD schemas from any JAXB-annotated xref:ug:fun:building-blocks.adoc#vi
This is instead of and preferable to using the JAXB link:https://jaxb.java.net/2.2.4/docs/schemagen.html[schemagen]
tool, because it uses the framework's support (via
xref:rg:ant:XmlJavaTypeAdapter.adoc[`@XmlJavaTypeAdapter`]) to translate any references to domain
-objects into ``OidDto``s (as defined by the Apache Isis xref:rg:cms:schema/common.adoc[common schema]).
+objects into ``OidDto``s (as defined by the Apache Isis xref:rg:cms:schema.adoc#common[common schema]).
The `xsd` goal defines the following properties:
@@ -24,7 +24,7 @@ Defaults to `generated-resources/isis-xsd`
* `separate` - (optional) whether to create separate directories for each JAXB-class. +
+
-Defaults to `false`. Most DTO classes will reference one another or the xref:rg:cms:schema/common.adoc[common schema]. Normally it's fine to merge all these XSDs together. This property, if set, results in each a separate directory for each generation of its XSD or XSDs.
+Defaults to `false`. Most DTO classes will reference one another or the xref:rg:cms:schema.adoc#common[common schema]. Normally it's fine to merge all these XSDs together. This property, if set, results in each a separate directory for each generation of its XSD or XSDs.
* `commonSchemas` - (optional) whether to also generate the isis common schema(s). +
+
@@ -276,14 +276,14 @@ The `xjc` profile is defined as:
<1> enabled _unless_ `skip.xjc` property specified
<2> specifies the directory that the XSD schemas were generated to by the `isis-maven-plugin`
<3> specify each of the XSDs to be processed
-<4> catalog file indicates the location of the referenced xref:rg:cms:schema/common.adoc[common schema] XSDs.
+<4> catalog file indicates the location of the referenced xref:rg:cms:schema.adoc#common[common schema] XSDs.
<5> the `build-helper-maven-plugin` adds the Java source generated by the `xjc` plugin so that it can be compiled and
packaged as any other code
<6> the location that the `xjc` plugin generates its source code.
The referenced `catalog.xml` file instructs the `xjc` plugin how to resolve referenced schema locations. Only a
-reference for the Apache Isis xref:rg:cms:schema/common.adoc[common schema] is likely to be needed:
+reference for the Apache Isis xref:rg:cms:schema.adoc#common[common schema] is likely to be needed:
[source,xml]
----
diff --git a/core/viewer-restfulobjects/_adoc/modules/ROOT/pages/layout-resources.adoc b/core/viewer-restfulobjects/_adoc/modules/ROOT/pages/layout-resources.adoc
index 83e606f..da4084a 100644
--- a/core/viewer-restfulobjects/_adoc/modules/ROOT/pages/layout-resources.adoc
+++ b/core/viewer-restfulobjects/_adoc/modules/ROOT/pages/layout-resources.adoc
@@ -127,7 +127,7 @@ The representation returned by the domain object resource (section 14.4 of the R
}
----
-Note that because of dynamic icons (the xref:rg:cms:methods/reserved.adoc#iconName[`iconName()`] supporting method) the image returned can vary on an instance-by-instance basis.
+Note that because of dynamic icons (the xref:rg:cms:methods.adoc#iconName[`iconName()`] supporting method) the image returned can vary on an instance-by-instance basis.
== Domain Object Layout
diff --git a/core/viewer-wicket/_adoc/modules/ROOT/pages/layout/file-based.adoc b/core/viewer-wicket/_adoc/modules/ROOT/pages/layout/file-based.adoc
index 18a1da6..9525d4c 100644
--- a/core/viewer-wicket/_adoc/modules/ROOT/pages/layout/file-based.adoc
+++ b/core/viewer-wicket/_adoc/modules/ROOT/pages/layout/file-based.adoc
@@ -35,7 +35,7 @@ A domain object may also have multiple layouts.
For example, there may be the capability to switch into an "edit" mode, which perhaps hides some class members, shows others (perhaps mixins specific to data entry).
Another reason might be to support different tenancies/user groups, where different business processes might require a slightly different UI representation.
-One way in which the domain object can specify an alternate layout is through its xref:rg:cms:methods/reserved.adoc#layout[`layout()`] method.
+One way in which the domain object can specify an alternate layout is through its xref:rg:cms:methods.adoc#layout[`layout()`] method.
If this returns a non-null value, say "edit", then this is used to locate an alternative layout, in the form `Xxx-edit.layout.xml`.