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 2017/07/20 21:54:54 UTC
[4/4] isis git commit: ISIS-1521: reformats some adocs,
each sentence on its own line
ISIS-1521: reformats some adocs, each sentence on its own line
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/65eb3591
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/65eb3591
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/65eb3591
Branch: refs/heads/master
Commit: 65eb3591e8e6068484f9fdd1917d8541977ad6f1
Parents: a302af3
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Thu Jul 20 22:54:38 2017 +0100
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Thu Jul 20 22:54:38 2017 +0100
----------------------------------------------------------------------
...rgcms_classes_AppManifest-bootstrapping.adoc | 58 ++++++++++++--------
...ms_classes_contributee_HasTransactionId.adoc | 8 +--
.../_rgcms_classes_contributee_HasUserName.adoc | 3 +-
.../rgcms/_rgcms_classes_domainevent.adoc | 4 +-
...s_classes_domainevent_ActionDomainEvent.adoc | 4 +-
...asses_domainevent_CollectionDomainEvent.adoc | 4 +-
...classes_domainevent_PropertyDomainEvent.adoc | 4 +-
.../guides/rgcms/_rgcms_classes_layout.adoc | 40 +++++++++-----
.../rgcms/_rgcms_classes_lifecycleevent.adoc | 28 ++++------
...asses_lifecycleevent_ObjectCreatedEvent.adoc | 4 +-
...lasses_lifecycleevent_ObjectLoadedEvent.adoc | 3 +-
...ses_lifecycleevent_ObjectPersistedEvent.adoc | 4 +-
...es_lifecycleevent_ObjectPersistingEvent.adoc | 4 +-
...sses_lifecycleevent_ObjectRemovingEvent.adoc | 4 +-
...asses_lifecycleevent_ObjectUpdatedEvent.adoc | 7 +--
...sses_lifecycleevent_ObjectUpdatingEvent.adoc | 7 +--
.../guides/rgcms/_rgcms_classes_mixins_Dto.adoc | 25 ++++-----
.../_rgcms_classes_mixins_Persistable.adoc | 30 ++++++----
.../guides/rgcms/_rgcms_classes_roles.adoc | 3 +-
.../_rgcms_classes_roles_HoldsUpdatedAt.adoc | 6 +-
.../_rgcms_classes_roles_HoldsUpdatedBy.adoc | 2 +
.../_rgcms_classes_roles_Timestampable.adoc | 7 ++-
.../guides/rgcms/_rgcms_classes_spec.adoc | 6 +-
.../guides/rgcms/_rgcms_classes_super.adoc | 3 +-
...s_classes_super_AbstractContainedObject.adoc | 5 +-
...gcms_classes_super_AbstractDomainObject.adoc | 6 +-
...sses_super_AbstractFactoryAndRepository.adoc | 5 +-
.../_rgcms_classes_super_AbstractService.adoc | 3 +-
..._rgcms_classes_super_AbstractSubscriber.adoc | 11 ++--
.../_rgcms_classes_super_AbstractViewModel.adoc | 3 +-
.../_rgcms_classes_super_FixtureScript.adoc | 3 +-
.../_rgcms_classes_super_FixtureScripts.adoc | 4 +-
32 files changed, 157 insertions(+), 151 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
index 302b1c7..c638735 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc
@@ -12,7 +12,8 @@ This section describes how to implement the `AppManifest` interface to bootstrap
== API
-The `AppManifest` interface allows the constituent parts of an application to be defined programmatically, most specifically the packages that contain domain services and/or persistent entities. Its API is defined as:
+The `AppManifest` interface allows the constituent parts of an application to be defined programmatically, most specifically the packages that contain domain services and/or persistent entities.
+Its API is defined as:
[source,java]
----
@@ -39,7 +40,9 @@ The following sections describe each of these methods in a little more detail.
=== `getModules()`
-The most significant method (the only one which must return a non-`null` value) is the `getModules()` method. Each module is identified by a class; the framework simply uses that class' package as the root to search for domain services (annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`]) and entities (annotated with xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`]). Generally there is one such module class per Maven module.
+The most significant method (the only one which must return a non-`null` value) is the `getModules()` method.
+Each module is identified by a class; the framework simply uses that class' package as the root to search for domain services (annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`]) and entities (annotated with xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`]).
+Generally there is one such module class per Maven module.
A module class for a domain module might for example be defined as:
@@ -53,7 +56,8 @@ public final class MyAppDomainModule {
This tells the framework that the package and subpackages under `com.mycompany.myapp.dom` should be searched for domain services (annotated with `@DomainService`), mixins (`@Mixin`) and entities (`@PersistenceCapabable`).
-As is perhaps apparent, the `getModules()` method replaces and overrides both the `isis.services.ServicesInstallerFromAnnotation.packagePrefix` key (usually found in the `isis.properties` file) and also the`isis.persistor.datanucleus.RegisterEntities.packagePrefix` key (usually found in the `persistor_datanucleus.properties` file). The value of the `isis.services-installer` configuration property is also ignored.
+As is perhaps apparent, the `getModules()` method replaces and overrides both the `isis.services.ServicesInstallerFromAnnotation.packagePrefix` key (usually found in the `isis.properties` file) and also the`isis.persistor.datanucleus.RegisterEntities.packagePrefix` key (usually found in the `persistor_datanucleus.properties` file).
+The value of the `isis.services-installer` configuration property is also ignored.
For example, the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp] defines the following:
@@ -82,7 +86,8 @@ As can be seen, the various (non-ASF) link:http://www.isisaddons.org[Isis Addons
=== `getAdditionalServices()`
-We normally we recommend that services are defined exclusively through `getModules()`, and that this method should therefore return an empty list. However, there are certain use cases where the a service must be explicitly specified either because the service required does not (for whatever reason) have a xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`] annotation.
+We normally we recommend that services are defined exclusively through `getModules()`, and that this method should therefore return an empty list.
+However, there are certain use cases where the a service must be explicitly specified either because the service required does not (for whatever reason) have a xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`] annotation.
For example, the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module (v1.9.0) allows the policy to evaluate conflicting permissions to be specified by explicitly registering either the `PermissionsEvaluationServiceAllowBeatsVeto` domain service or the `PermissionsEvaluationServiceVetoBeatsAllow` domain service:
@@ -103,7 +108,9 @@ If this method returns a non-`null` value, then it overrides the value of `isis.
=== `getAuthenticationMechanism()`
-If non-`null`, this method specifies the authentication mechanism to use. The valid values are currently `"shiro"` or `"bypass"`. If null is returned then the value of the `isis.authentication` configuration property (in `isis.properties` file) is used instead.
+If non-`null`, this method specifies the authentication mechanism to use.
+The valid values are currently `"shiro"` or `"bypass"`.
+If null is returned then the value of the `isis.authentication` configuration property (in `isis.properties` file) is used instead.
See the xref:../ugsec/ugsec.adoc#[security guide] for further details on configuring shiro or bypass security.
@@ -116,7 +123,9 @@ This property is ignored for integration tests (which always uses the `"bypass"`
=== `getAuthorizationMechanism()`
-If non-`null`, this method specifies the authorization mechanism to use. The valid values are currently `"shiro"` or `"bypass"`. If null is returned then the value of the `isis.authorization` configuration property (in `isis.properties` file) is used instead.
+If non-`null`, this method specifies the authorization mechanism to use.
+The valid values are currently `"shiro"` or `"bypass"`.
+If null is returned then the value of the `isis.authorization` configuration property (in `isis.properties` file) is used instead.
See the xref:../ugsec/ugsec.adoc#[security guide] for further details on configuring shiro or bypass security.
@@ -130,7 +139,8 @@ This property is ignored for integration tests (which always uses the `"bypass"`
=== `getFixtures()`
-If non-`null`, this method specifies the fixture script(s) to be run on startup. This is particularly useful when developing or demoing while using an in-memory database.
+If non-`null`, this method specifies the fixture script(s) to be run on startup.
+This is particularly useful when developing or demoing while using an in-memory database.
For example:
@@ -144,13 +154,15 @@ public List<Class<? extends FixtureScript>> getFixtures() {
-Note that in order for fixtures to be installed it is also necessary to set the `isis.persistor.datanucleus.install-fixtures` key to `true`. This can most easily be done using the `getConfigurationProperties()` method, discussed below.
+Note that in order for fixtures to be installed it is also necessary to set the `isis.persistor.datanucleus.install-fixtures` key to `true`.
+This can most easily be done using the `getConfigurationProperties()` method, discussed below.
=== `getConfigurationProperties()`
-This method allow arbitrary other configuration properties to be overridden. One common use case is in conjunction with the `getFixtures()` method, discussed above:
+This method allow arbitrary other configuration properties to be overridden.
+One common use case is in conjunction with the `getFixtures()` method, discussed above:
[source,java]
----
@@ -170,11 +182,14 @@ public Map<String, String> getConfigurationProperties() {
== Bootstrapping
-One of the primary goals of the `AppManifest` is to unify the bootstrapping of both integration tests and the webapp. This requires that the integration tests and webapp can both reference the implementation.
+One of the primary goals of the `AppManifest` is to unify the bootstrapping of both integration tests and the webapp.
+This requires that the integration tests and webapp can both reference the implementation.
-We strongly recommend using a `myapp-app` Maven module to hold the implementation of the `AppManifest`. This Maven module can then also hold dependencies which are common to both integration tests and the webapp, specifically the `org.apache.isis.core:isis-core-runtime` and the `org.apache.isis.core:isis-core-wrapper` modules.
+We strongly recommend using a `myapp-app` Maven module to hold the implementation of the `AppManifest`.
+This Maven module can then also hold dependencies which are common to both integration tests and the webapp, specifically the `org.apache.isis.core:isis-core-runtime` and the `org.apache.isis.core:isis-core-wrapper` modules.
-We also strongly recommend that any application-layer domain services and view models (code that references persistent domain entities but that is not referenced back) is moved to this `myapp-app` module. This will allow the architectural layering of the overall application to be enforced by Maven.
+We also strongly recommend that any application-layer domain services and view models (code that references persistent domain entities but that is not referenced back) is moved to this `myapp-app` module.
+This will allow the architectural layering of the overall application to be enforced by Maven.
What then remains is to update the bootstrapping code itself.
@@ -183,9 +198,8 @@ What then remains is to update the bootstrapping code itself.
=== Integration Tests
-A `AppManifest.Util` helper class provides a number of static methods that can be used to set up configuration
-properties appropriate for integration testing (eg run using an in-memory database). This allows the responsibility
-of returning the configuration properties to belong exlusively to the `AppManifest`.
+A `AppManifest.Util` helper class provides a number of static methods that can be used to set up configuration properties appropriate for integration testing (eg run using an in-memory database).
+This allows the responsibility of returning the configuration properties to belong exlusively to the `AppManifest`.
There are three such static methods:
@@ -237,8 +251,8 @@ public class DomainAppSystemInitializer {
----
-Previously the `IsisConfigurationJdoIntegTests` (subclass of `IsisConfiguration`) was provided to set up these
-configuration properties. This class is still supported, but is deprecated.
+Previously the `IsisConfigurationJdoIntegTests` (subclass of `IsisConfiguration`) was provided to set up these configuration properties.
+This class is still supported, but is deprecated.
@@ -289,18 +303,14 @@ java org.apache.isis.WebServer -m com.mycompany.myapp.MyAppAppManifestWithFixtur
-
-
-
-
-
== Subsidiary Goals
-There are a number of subsidiary goals of the `AppManifest` class (though as of v1.13.0 these have not yet implemented):
+There are a number of subsidiary goals of the `AppManifest` class (though not all of these are fully implemented):
* Allow different integration tests to run with different manifests.
-** Normally the running application is shared (on a thread-local) between integration tests. What the framework could perhaps do is to be intelligent enough to keep track of the manifest in use for each integration test and tear down the shared state if the "next" test uses a different manifest
+** Normally the running application is shared (on a thread-local) between integration tests.
+What the framework could perhaps do is to be intelligent enough to keep track of the manifest in use for each integration test and tear down the shared state if the "next" test uses a different manifest
* Provide a programmatic way to contribute elements of `web.xml`.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc
index 1edd61f..24debad 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc
@@ -6,14 +6,12 @@
The `HasTransactionId` interface is a mix-in for any domain objects that reference a transaction id, such as
-auditing entries or commands, or for xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[``Interaction``]s persisted as
-published events.
+auditing entries or commands, or for xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[``Interaction``]s persisted as published events.
[NOTE]
====
-Prior to `1.13.0`, this identifier was the GUID of the Isis transaction in which the object was created (hence the
-name). As of `1.13.0`, this identifier actually is for the request/interaction in which the object was created, so is
-actually now mis-named.
+Prior to `1.13.0`, this identifier was the GUID of the Isis transaction in which the object was created (hence the name).
+As of `1.13.0`, this identifier actually is for the request/interaction in which the object was created, so is actually now mis-named.
====
The interface is defined is:
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasUserName.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasUserName.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasUserName.adoc
index 619620b..41e580e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasUserName.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasUserName.adoc
@@ -5,7 +5,8 @@
:_imagesdir: images/
-The `HasUsername` interface is a mix-in for domain objects to be associated with a username. Other services and modules can then contribute actions/collections to render such additional information relating to the activities of the user.
+The `HasUsername` interface is a mix-in for domain objects to be associated with a username.
+Other services and modules can then contribute actions/collections to render such additional information relating to the activities of the user.
The interface is defined is:
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc
index 01153bb..d5cb942 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc
@@ -7,8 +7,8 @@
This section catalogues the various domain event classes defined by Apache Isis.
-These events are broadcast on the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`]. The domain
-events are broadcast as a result of being specified in the xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`], xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`] or xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`] attributes.
+These events are broadcast on the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`].
+The domain events are broadcast as a result of being specified in the xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`], xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`] or xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`] attributes.
They are listed in the table below.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
index 98ea876..81d8819 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc
@@ -45,8 +45,8 @@ public abstract class ActionDomainEvent<S> extends AbstractDomainEvent<S> {
}
----
<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Action_domainEvent[`@Action#domainEvent()`]
-annotation attribute. Whether this raises an event or not depends upon the
-`isis.reflector.facet.actionAnnotation.domainEvent.postForDefault` configuration property.
+annotation attribute.
+Whether this raises an event or not depends upon the `isis.reflector.facet.actionAnnotation.domainEvent.postForDefault` configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting).
<3> Similarly, the `Doop` class is provided as a convenience to indicate that an event _should_ be raised (irrespective of the configuration property setting).
<4> Deprecated, use xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_CommandContext[`CommandContext`] or (better) xref:../rgsvc/rgsvc.adoc#_rgsvc_application-layer-api_InteractionContext[`InteractionContext`]instead.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
index a258cfa..cf7c7e6 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc
@@ -38,8 +38,8 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S>
public Of getOf(); // <5>
}
----
-<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Collection_domainEvent[`@Collection#domainEvent()`]
-annotation attribute. Whether this raises an event or not depends upon the
+<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Collection_domainEvent[`@Collection#domainEvent()`] annotation attribute.
+Whether this raises an event or not depends upon the
`isis.reflector.facet.collectionAnnotation.domainEvent.postForDefault` configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting).
<3> Similarly, the `Doop` class is provided as a convenience to indicate that an event _should_ be raised (irrespective of the configuration property setting).
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
index a2d16b5..ceeb6c7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc
@@ -36,8 +36,8 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> {
public T getNewValue(); // <5>
}
----
-<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`]
-annotation attribute. Whether this raises an event or not depends upon the
+<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`] annotation attribute.
+Whether this raises an event or not depends upon the
`isis.reflector.facet.propertyAnnotation.domainEvent.postForDefault` configuration property.
<2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting).
<3> Similarly, the `Doop` class is provided as a convenience to indicate that an event _should_ be raised (irrespective of the configuration property setting).
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
index 530f6e4..493abfe 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc
@@ -5,19 +5,22 @@
:_imagesdir: images/
-The `org.apache.isis.applib.layout` package defines a number of classes that allow the layout of domain objects
-(entities and view models) to be customized. These classes fall into two main categories:
+The `org.apache.isis.applib.layout` package defines a number of classes that allow the layout of domain objects (entities and view models) to be customized.
+These classes fall into two main categories:
* grid classes, that define a grid structure of rows, columns, tab groups and tabs, and;
-* common component classes, that capture the layout metadata for an object's properties, collections and actions. These are bound (or associated) to the regions of the grid
+* common component classes, that capture the layout metadata for an object's properties, collections and actions.
+These are bound (or associated) to the regions of the grid
-The framework provides an implementation of the grid classes modelled closely on link:http://getbootstrap.com[Bootstrap 3], along with xref:../ugvw/ugvw.adoc#[Wicket viewer] components capable of rendering that grid system. In principle it is
-also possible to extend the layout architecture for other grid systems. The component classes, though, are intended to be reusable across all grid systems.
+The framework provides an implementation of the grid classes modelled closely on link:http://getbootstrap.com[Bootstrap 3], along with xref:../ugvw/ugvw.adoc#[Wicket viewer] components capable of rendering that grid system.
+In principle it is also possible to extend the layout architecture for other grid systems.
+The component classes, though, are intended to be reusable across all grid systems.
The component classes, meanwhile, are broadly equivalent to the "layout" annotations (xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] and xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`]
-All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the `component` classes in the `http://isis.apache.org/applib/layout/component` XSD namespace, the bootstrap 3 grid classes in the `http://isis.apache.org/applib/layout/grid/bootstrap3` XSD namespace). This ability to serialize to/from XML is used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_GridLoaderService[`GridLoaderService`], the default implementation of which reads the grid layout for a domain class from a `.layout.xml` file on the classpath.
+All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the `component` classes in the `http://isis.apache.org/applib/layout/component` XSD namespace, the bootstrap 3 grid classes in the `http://isis.apache.org/applib/layout/grid/bootstrap3` XSD namespace).
+This ability to serialize to/from XML is used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_presentation-layer-spi_GridLoaderService[`GridLoaderService`], the default implementation of which reads the grid layout for a domain class from a `.layout.xml` file on the classpath.
@@ -41,7 +44,9 @@ A fieldset (previously also called a property group or member group) of a number
** `DomainObjectLayoutData`, corresponding to the xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`] annotation.
-In addition, the component package includes `Grid`, representing the top level container for a custom layout for a domain object. `Grid` itself is merely an interface, but it also defines the visitor pattern to make it easy for validate and normalize the grid layouts. The `GridAbstract` convenience superclass provides a partial implementation of this visitor pattern.
+In addition, the component package includes `Grid`, representing the top level container for a custom layout for a domain object.
+`Grid` itself is merely an interface, but it also defines the visitor pattern to make it easy for validate and normalize the grid layouts.
+The `GridAbstract` convenience superclass provides a partial implementation of this visitor pattern.
@@ -50,9 +55,12 @@ In addition, the component package includes `Grid`, representing the top level c
As noted above, the default bootstrap3 grid classes are modelled closely on link:http://getbootstrap.com[Bootstrap 3].
Bootstrap's link:http://getbootstrap.com/css/#grid[grid system] divides the page width equally into 12 columns, and so
-each column spans 1 or more of these widths. Thus, a column with a span of 12 is the full width, one with a span of 6 is half the width, one with a span of 4 is a third of the width, and so on.
+each column spans 1 or more of these widths.
+Thus, a column with a span of 12 is the full width, one with a span of 6 is half the width, one with a span of 4 is a third of the width, and so on.
-When specifying the span of a column, Bootstrap also allows a size to be specified (`XS`, `SM`, `MD`, `LG`). The size determines the rules for responsive design. Apache Isis defaults to `MD` but this can be overridden. It is also possible to specify multiple size/spans for a given column.
+When specifying the span of a column, Bootstrap also allows a size to be specified (`XS`, `SM`, `MD`, `LG`). The size determines the rules for responsive design.
+Apache Isis defaults to `MD` but this can be overridden.
+It is also possible to specify multiple size/spans for a given column.
The grid classes provided by Apache Isis reside in the `org.apache.isis.applib.layout.grid.bootstrap3` package, and consist of:
@@ -60,7 +68,8 @@ The grid classes provided by Apache Isis reside in the `org.apache.isis.applib.l
+
Consists of a number of ``BS3Row``s. +
+
-This class is the concrete implementation of `Grid` interface, discussed previously. As such, it extends the `Grid.Visitor` to iterate over all of the ``Row``s of the grid.
+This class is the concrete implementation of `Grid` interface, discussed previously.
+As such, it extends the `Grid.Visitor` to iterate over all of the ``Row``s of the grid.
* `BS3Row` +
+
@@ -68,7 +77,9 @@ A container of ``BS3Col``s. This element is rendered as `<div class="row">`.
* `BS3Col` +
+
-A container of almost everything else. A column most commonly contains properties (grouped into ``FieldSet``s, described above) or collections (specified by ``CollectionLayoutData``, also above). However, a `Col` might instead contain a ``BS3TabGroup`` (described below) in order that the object members is arranged into tabs. +
+A container of almost everything else.
+A column most commonly contains properties (grouped into ``FieldSet``s, described above) or collections (specified by ``CollectionLayoutData``, also above).
+However, a `Col` might instead contain a ``BS3TabGroup`` (described below) in order that the object members is arranged into tabs. +
+
It is also possible for a ``Col`` to contain the object's title/icon (using ``DomainObjectLayoutData``) or indeed arbitrary actions (using ``ActionLayoutData`). +
+
@@ -84,11 +95,12 @@ A container of ``BS3Tab``s.
+
A container of ``BS3Row``s, which will in turn contain ``BS3Col``s and thence ultimately the object's members.
-There are also two close cousins of `Col`, namely `ClearFixVisible` and `ClearFixHidden`. These map to Bootstrap's link:http://getbootstrap.com/css/#responsive-utilities[responsive utility class]es, and provide greater control for
-responsive designs.
+There are also two close cousins of `Col`, namely `ClearFixVisible` and `ClearFixHidden`.
+These map to Bootstrap's link:http://getbootstrap.com/css/#responsive-utilities[responsive utility class]es, and provide greater control for responsive designs.
As you can probably guess, the `BS3Grid` is the top-level object (that is, it is JAXB `@XmlRootElement`); this is the object that is serialized to/from XML.
-All of these classes also allow custom CSS to be specified; these are added to the CSS classes for the corresponding `<div`> in the rendered page. The xref:../ugvw/ugvw.adoc#_ugvw_customisation_tweaking-css-classes[`application.css`] file can then be used for application-specific CSS, allowing arbitrary fine-tuning of the layout of the page.
+All of these classes also allow custom CSS to be specified; these are added to the CSS classes for the corresponding `<div`> in the rendered page.
+The xref:../ugvw/ugvw.adoc#_ugvw_customisation_tweaking-css-classes[`application.css`] file can then be used for application-specific CSS, allowing arbitrary fine-tuning of the layout of the page.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc
index 7ebab74..b881df1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc
@@ -5,8 +5,8 @@
:_imagesdir: images/
-This section catalogues the various lifecycle event classes defined by Apache Isis. These events
-are fired automatically when a domain object is loaded, created, updated and so forth.
+This section catalogues the various lifecycle event classes defined by Apache Isis.
+These events are fired automatically when a domain object is loaded, created, updated and so forth.
The lifecycle event classes are listed in the table below:
@@ -38,8 +38,7 @@ Impl'n (g: a:)
``isis-core-applib``
|(abstract class). +
`ObjectCreatedEvent.Default` is the concrete implementation that is used.
-|Broadcast when an object is first instantiated
-using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
+|Broadcast when an object is first instantiated using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
`#newTransientInstance(...)` method.
@@ -49,7 +48,7 @@ using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_
``services.eventbus`` +
``isis-core-applib``
|(abstract class). +
-`ObjectLoadedEvent.Default` is the concrete implementation that is used.
+`ObjectLoadedEvent.Default` is the concrete implementation that is used.
|Broadcast when an object is retrieved from the database.
@@ -60,8 +59,7 @@ using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_
``isis-core-applib``
|(abstract class). +
`ObjectPersistedEvent.Default` is the concrete implementation that is used.
-|Broadcast when an object is first saved (inserted) into the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+|Broadcast when an object is first saved (inserted) into the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#persist(...)` method.
@@ -72,8 +70,7 @@ xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-per
``isis-core-applib``
|(abstract class). +
`ObjectPersistingEvent.Default` is the concrete implementation that is used.
-|Broadcast when an object is about to be saved (inserted) into the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+|Broadcast when an object is about to be saved (inserted) into the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#persist(...)` method.
@@ -84,8 +81,7 @@ xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-per
``isis-core-applib``
|(abstract class). +
`ObjectRemovingEvent.Default` is the concrete implementation that is used.
-|Broadcast when an object is about to be deleted from the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+|Broadcast when an object is about to be deleted from the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#remove(...)` method.
@@ -96,9 +92,8 @@ xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-per
``isis-core-applib``
|(abstract class). +
`ObjectUpdatedEvent.Default` is the concrete implementation that is used.
-|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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+|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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
@@ -109,9 +104,8 @@ xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-per
``isis-core-applib``
|(abstract class). +
`ObjectUpdatingEvent.Default` is the concrete implementation that is used.
-|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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+|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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
index a84003f..402f8a2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
@@ -6,9 +6,7 @@
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is first instantiated using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first instantiated using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
`#newTransientInstance(...)` method.
`ObjectCreatedEvent.Default` is the concrete implementation that is used.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
index 8bcd12d..5e76326 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
@@ -6,8 +6,7 @@
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is retrieved from the database.
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is retrieved from the database.
`ObjectLoadedEvent.Default` is the concrete implementation that is used.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
index e2aed63..0d902c4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
@@ -5,9 +5,7 @@
:_imagesdir: images/
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is first saved (inserted) into the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first saved (inserted) into the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#persist(...)` method.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
index 7c62c34..8788715 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
@@ -5,9 +5,7 @@
:_imagesdir: images/
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is about to be saved (inserted) into the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be saved (inserted) into the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#persist(...)` method.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
index a05e2be..8449260 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
@@ -5,9 +5,7 @@
:_imagesdir: images/
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is about to be deleted from the database using the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be deleted from the database using the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
`#remove(...)` method.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
index daf6bb7..dc91cbf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
@@ -6,11 +6,8 @@
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
-`#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
`ObjectUpdatedEvent.Default` is the concrete implementation that is used.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
index 415b5c4..2d46dba 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
@@ -6,11 +6,8 @@
-Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
-`#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
+Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_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:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
`ObjectUpdatingEvent.Default` is the concrete implementation that is used.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc
index d169c57a..cda020a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc
@@ -6,8 +6,8 @@
The `Dto` role interface is intended to be implemented by JAXB-annotated view models, that is, annotated using
-xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]. It enables the ability to download the XML and
-XSD schema of those objects using two xref:../ugfun/ugfun.adoc#_ugfun_building-blocks_types-of-domain-objects_mixins[mixins], `Dto_downloadXml` and `Dto_downloadXsd`.
+xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`].
+It enables the ability to download the XML and XSD schema of those objects using two xref:../ugfun/ugfun.adoc#_ugfun_building-blocks_types-of-domain-objects_mixins[mixins], `Dto_downloadXml` and `Dto_downloadXsd`.
The interface is just a marker interface (with no members), and is defined as:
@@ -23,13 +23,12 @@ The `Dto_downloadXml` mixin defines the following action:
@Mixin
public class Dto_downloadXml {
public Dto_downloadXml(final Dto dto) { ... } // <1>
- public Object downloadXml(final String fileName) { ... } // <2>
+ public Object $$(final String fileName) { ... } // <2>
...
}
----
<1> provided as an action to any class that (trivially) implements the `Dto` interface
-<2> actually this method is called '$$' in the code, a "special case" that means to use the derive the action name
-from the class name.
+<2> The '$$' name is a "special case", indicating the the action's name be derived from the class name.
This will return the XML text wrapped up in a xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`].
@@ -40,22 +39,18 @@ The `Dto_downloadXsd` mixin is similar:
@Mixin
public class Dto_downloadXsd {
public Dto_downloadXsd(final Dto dto) { ... } // <1>
- public Object downloadXsd(final String fileName, final IsisSchemes isisSchemas) { ... } // <2>
+ public Object $$(final String fileName, final IsisSchemes isisSchemas) { ... } // <2>
}
----
<1> provided as an action to any class that (trivially) implements the `Dto` interface
-<2> actually this is '$$' in the code, a "special case" that means to use the derive the action name from the class name.
+<2> The '$$' name is a "special case", indicating the 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:../rgcms/rgcms.adoc#_rgcms_classes_value-types_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:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]. The `IsisSchemas` parameter to the action can be used to
-optionally ignore the common xref:../rgcms/rgcms.adoc#_rgcms_schema[Apache Isis schemas] (useful if there is only one other XSD schema
-referenced by the DTO).
+If the domain object's JAXB annotations reference only a single XSD schema then this will return that XML text as a xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_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:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`].
+The `IsisSchemas` parameter to the action can be used to optionally ignore the common xref:../rgcms/rgcms.adoc#_rgcms_schema[Apache Isis schemas] (useful if there is only one other XSD schema referenced by the DTO).
== Related Services
-The `Dto_downloadXml` and `Dto_downloadXsd` delegate to the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_JaxbService[`JaxbService`] to actually generate the XML/XSD.
\ No newline at end of file
+The `Dto_downloadXml` and `Dto_downloadXsd` delegate to the xref:../rgsvc/rgsvc.adoc#_rgsvc_integration-api_JaxbService[`JaxbService`] to actually generate the XML/XSD.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc
index 9a1a6df..644353a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc
@@ -6,14 +6,15 @@
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.
+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.
+
[[__rgcms_classes_mixins_Persistable_downloadJdoMetadata]]
== `downloadJdoMetadata()`
-The `Persistable_downloadJdoMetadata` mixin provides an action which allows the
-JDO link:http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html[class metadata] to be downloaded as XML. It has the following signature:
+The `Persistable_downloadJdoMetadata` mixin provides an action which allows the JDO link:http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html[class metadata] to be downloaded as XML.
+It has the following signature:
[source,java]
----
@@ -30,27 +31,32 @@ public Clob downloadJdoMetadata( // <1>
This mixin action is associated with the "Metadata" fieldset, and will appear as a panel drop-down action.
-These mixin properties are all associated with the "Metadata" fieldset. The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
+These mixin properties are all associated with the "Metadata" fieldset.
+The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
=== Related Services
-The mixin delegates to the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_IsisJdoSupport[`IsisJdoSupport`] service to obtain
-a reference to the JDO `PersistenceManagerFactory`.
+The mixin delegates to the xref:../rgsvc/rgsvc.adoc#_rgsvc_persistence-layer-api_IsisJdoSupport[`IsisJdoSupport`] service to obtain a reference to the JDO `PersistenceManagerFactory`.
[[__rgcms_classes_mixins_Persistable_datanucleusXxx]]
== `datanucleusXxx`
-The framework provides a number of mixins that expose the datanucleus Id and version of a persistable domain entity. Several implementations are provided to support different datatypes:
+The framework provides a number of mixins that expose the datanucleus Id and version of a persistable domain entity.
+Several implementations are provided to support different datatypes:
-* `Persistable_datanucleusIdLong` will expose the entity's id, assuming that the id is or can be cast to `java.lang.Long`. Otherwise the property will be hidden.
+* `Persistable_datanucleusIdLong` will expose the entity's id, assuming that the id is or can be cast to `java.lang.Long`.
+Otherwise the property will be hidden.
-* `Persistable_datanucleusVersionTimestamp` will expose the entity's version, assuming that the version is or can be cast to `java.sql.Timestamp`. Otherwise the property will be hidden.
+* `Persistable_datanucleusVersionTimestamp` will expose the entity's version, assuming that the version is or can be cast to `java.sql.Timestamp`.
+Otherwise the property will be hidden.
-* `Persistable_datanucleusVersionLong` will expose the entity's version, assuming that the version is or can be cast to `java.lang.Long`. Otherwise the property will be hidden.
+* `Persistable_datanucleusVersionLong` will expose the entity's version, assuming that the version is or can be cast to `java.lang.Long`.
+Otherwise the property will be hidden.
=== Appearance in the UI
-These mixin properties are all associated with the "Metadata" fieldset. The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
+These mixin properties are all associated with the "Metadata" fieldset.
+The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles.adoc
index ee429af..c9b16be 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles.adoc
@@ -5,8 +5,7 @@
:_imagesdir: images/
-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.
+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.
include::_rgcms_classes_roles_HoldsUpdatedAt.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc
index 94a3c7d..fc0c9ff 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc
@@ -5,8 +5,7 @@
:_imagesdir: images/
-The `HoldsUpdatedAt` role interface allows the (framework-provided) `TimestampService` to update each object with
-the current timestamp whenever it is modified in a transaction.
+The `HoldsUpdatedAt` role interface allows the (framework-provided) `TimestampService` to update each object with the current timestamp whenever it is modified in a transaction.
The interface is defined as:
@@ -25,7 +24,8 @@ Entities that implement this interface often also implement xref:../rgcms/rgcms.
== Alternative approaches
-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`.
+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`.
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc
index b7781be..3b9d073 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc
@@ -7,6 +7,8 @@
The `HoldsUpdatedBy` role interface ...
+NOTE: FIXME ... incomplete
+
[source,java]
----
public interface HoldsUpdatedBy {
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc
index 154b15d..97e8e49 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc
@@ -5,7 +5,8 @@
:_imagesdir: images/
-The `Timestampable` role interface is a convenience that combines the xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces. It is defined as:
+The `Timestampable` role interface is a convenience that combines the xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces.
+It is defined as:
[source,java]
----
@@ -20,4 +21,6 @@ The interface no additional methods of its own.
== Alternatives
-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:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
+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:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc
index 3dc93b6..1de29fe 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc
@@ -52,7 +52,8 @@ public class Customer {
[_rgcms_classes_spec-Specification2]
== `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:../rgcms/rgcms.adoc#_rgcms_classes_i18n_TranslatableString[translatable string]:
+The `Specification2` interface extends the `Specification` API to add support for i18n.
+This is done by defining an additional method that returns a xref:../rgcms/rgcms.adoc#_rgcms_classes_i18n_TranslatableString[translatable string]:
[source,java]
----
@@ -71,7 +72,8 @@ Note that if implementing `Specification2` then there is no need to also provide
[_rgcms_classes_spec-adapter_classes]
== Adapter classes
-The `AbstractSpecification` and `AbstractSpecification2` adapter classes provide a partial implementation of the respective interfaces, providing type-safety. (Their design is modelled on the `TypesafeMatcher` class within link:http://hamcrest.org/JavaHamcrest/[Hamcrest]).
+The `AbstractSpecification` and `AbstractSpecification2` adapter classes provide a partial implementation of the respective interfaces, providing type-safety.
+(Their design is modelled on the `TypesafeMatcher` class within link:http://hamcrest.org/JavaHamcrest/[Hamcrest]).
For example:
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc
index c0c7f5e..e8e231c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc
@@ -5,7 +5,8 @@
:_imagesdir: images/
-This section catalogues the various convenience (non event) superclasses defined by Apache Isis. These are listed in the table below.
+This section catalogues the various convenience (non event) superclasses defined by Apache Isis.
+These are listed in the table below.
.Convenience Superclasses
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc
index cc12056..33aaa64 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc
@@ -5,12 +5,13 @@
:_imagesdir: images/
-This class is a convenience superclass for domain objects and services, providing general purpose methods for interacting with the framework. These include:
+This class is a convenience superclass for domain objects and services, providing general purpose methods for interacting with the framework.
+These include:
* `allMatches(Query)` - search for all objects matching the specified `Query`. +
+
+ Note that this, and other similar methods (eg `firstMatch(...)`, `uniqueMatch(...)`) will automatically flush the
-current transactoin.
+current transaction.
* `newTransientInstance(Class)` - to create a new instance of an object, with any services injected into it
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc
index 73fd665..5198faa 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc
@@ -5,10 +5,8 @@
:_imagesdir: images/
-This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding
-in convenience methods for managing the persistence lifecycle of the object instance.
+This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding in convenience methods for managing the persistence lifecycle of the object instance.
-Each of these methods, eg `isPersistent(...)`, delegates to an equivalent method in
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer[`DomainObjectContainer`].
+Each of these methods, eg `isPersistent(...)`, delegates to an equivalent method in xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer[`DomainObjectContainer`].
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
index d103cf6..4c24c57 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
@@ -5,9 +5,8 @@
:_imagesdir: images/
-This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`]. Its
-intent was to be a convenience subclass for services acting as either a repository or a factory, however note that
- all of the methods that it defines are now deprecated.
+This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`].
+Its intent was to be a convenience subclass for services acting as either a repository or a factory, however note that all of the methods that it defines are now deprecated.
Instead, indicate that a service is repository using the xref:../rgant/rgant.adoc#_rgant-DomainService_repositoryFor[`@DomainService#repositoryFor()`] attribute.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc
index dcd31de..85bb95a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc
@@ -4,7 +4,6 @@
:_basedir: ../../
:_imagesdir: images/
-This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding
-in an implementation of `getId()` based upon the classes name.
+This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding in an implementation of `getId()` based upon the classes name.
In practice there is little to gain from subclassing; simply inject xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_DomainObjectContainer[`DomainObjectContainer`] for broadly equivalent functionality.
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc
index 0f66319..f5475a7 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc
@@ -5,14 +5,13 @@
:_imagesdir: images/
-This is a convenience superclass for creating subscriber domain services on the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`]. It uses xref:../rgant/rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] and
-xref:../rgant/rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] callbacks to automatically register/unregister itself
+This is a convenience superclass for creating subscriber domain services on the xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`].
+It uses xref:../rgant/rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] and xref:../rgant/rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] callbacks to automatically register/unregister itself
with the `EventBusService`.
It's important that subscribers register before any domain services that might emit events on the
-xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`]. For example, the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module provides a domain service that automatically
-seeds certain domain entities; these will generate xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent[lifecycle events] and so
-any subscribers must be registered before such seed services. The easiest way to do this is to use the
-xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute.
+xref:../rgsvc/rgsvc.adoc#_rgsvc_core-domain-api_EventBusService[`EventBusService`].
+For example, the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module provides a domain service that automatically seeds certain domain entities; these will generate xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent[lifecycle events] and so any subscribers must be registered before such seed services.
+The easiest way to do this is to use the xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute.
As a convenience, the `AbstractSubscriber` specifies this attribute.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc
index 2e2c042..5655d9f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc
@@ -6,7 +6,8 @@
This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], also
-implementing the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface. In and of itself it provides no new behaviour.
+implementing the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface.
+In and of itself it provides no new behaviour.
[TIP]
====
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScript.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScript.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScript.adoc
index fe29442..9ff7a49 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScript.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScript.adoc
@@ -15,7 +15,8 @@ protected abstract void execute(final ExecutionContext executionContext);
----
In this method the fixture script can in theory do anything, but in practice it is recommended that it uses injected
-domain services to set up data. The provided `ExecutionContext` is used to invoke child fixture scripts, and alsocan be used to store references to any created objects (so that the calling test can access these objects/so that they are rendered in the view model).
+domain services to set up data.
+The provided `ExecutionContext` is used to invoke child fixture scripts, and alsocan be used to store references to any created objects (so that the calling test can access these objects/so that they are rendered in the view model).
See the see the xref:../ugtst/ugtst.adoc#_ugtst_fixture-scripts[user guide's testing chapter] for further discussion on the use of fixture scripts, in particular xref:../ugtst/ugtst.adoc#_ugtst_fixture-scripts_api-and-usage[fixture scripts' API and usage].
http://git-wip-us.apache.org/repos/asf/isis/blob/65eb3591/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc
index 1dc2498..e9acba4 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc
@@ -6,7 +6,7 @@
This abstract class is intended to allow a domain service that can execute xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`]s to be easily written.
-However, it has now been deprecated; instead we recommend that the xref:../rgsvc/rgsvc.adoc#_rgsvc_testing_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] service is
-implemented instead. The framework will then automatically use xref:../rgsvc/rgsvc.adoc#_rgsvc_testing_FixtureScriptsDefault[`FixtureScriptsDefault`] as a fallback implementation of this class.
+However, it has now been deprecated; instead we recommend that the xref:../rgsvc/rgsvc.adoc#_rgsvc_testing_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] service is implemented instead.
+The framework will then automatically use xref:../rgsvc/rgsvc.adoc#_rgsvc_testing_FixtureScriptsDefault[`FixtureScriptsDefault`] as a fallback implementation of this class.
See the see the xref:../ugtst/ugtst.adoc#_ugtst_fixture-scripts[user guide's testing chapter] for further discussion on the use of fixture scripts, in particular xref:../ugtst/ugtst.adoc#_ugtst_fixture-scripts_api-and-usage[fixture scripts' API and usage].