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/04/17 10:32:08 UTC
[14/43] isis git commit: ISIS-1521: fixes xref links between guides
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle.adoc
index 309c136..87c1ecc 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle.adoc
@@ -14,9 +14,9 @@ The lifecycle callback methods notify a domain entity about its interaction with
Note that these callbacks are fired by Apache Isis rather than JDO. In the future we may deprecate them because there are better mechanisms available using listeners/subscribers:
* in Isis 1.9.0 and earlier, you may therefore want to consider using the JDO API directly to set up a lifecycle
-listener; see xref:rgcms.adoc#_rgcms_methods_lifecycle_jdo-api[here] for further discussion.
+listener; see xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_jdo-api[here] for further discussion.
-* alternatively, you can use a subscriber for the xref:rgcms.adoc#_rgcms_classes_lifecycleevent[lifecycle event]s fired in Isis.
+* alternatively, you can use a subscriber for the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent[lifecycle event]s fired in Isis.
====
The lifecycle callback methods supported by Isis are:
@@ -28,28 +28,28 @@ The lifecycle callback methods supported by Isis are:
|Method
|Description
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_created[`created()`]
-|called when an object has just been created using xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`newTransientInstance()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_created[`created()`]
+|called when an object has just been created using xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`newTransientInstance()`]
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_loaded[`loaded()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_loaded[`loaded()`]
|called when a (persistent) object has just been loaded from the object store.
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`]
|called when object has just been persisted from the object store.
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`]
|called when a (not-yet-persistent) object is just about to be persisted from the object store
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`]
|called when a (persistent) object has just been deleted from the object store
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`]
|called when a (persistent) object is just about to be deleted from the object store
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_updated[`updated()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_updated[`updated()`]
|called when a (persistent) object has just been updated in the object store
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_updating[`updating()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_updating[`updating()`]
|called when a (persistent) object is just about to be updated in the object store
|===
@@ -66,10 +66,10 @@ Some lifecycle methods have been deprecated:
|Notes
|`deleted()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`]
+|Replaced by xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`]
|`deleting()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`]
+|Replaced by xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`]
|`loading()`
|callback for when the (persistent) object is just about to be loaded from the object store. +
@@ -80,10 +80,10 @@ This method is never called.
====
|`saved()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`]
+|Replaced by xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`]
|`saving()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`]
+|Replaced by xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`]
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_created.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_created.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_created.adoc
index 604689b..7880866 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_created.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_created.adoc
@@ -5,12 +5,12 @@
:_imagesdir: images/
-The `created()` lifecycle callback method is called when an object has just been created using xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`newTransientInstance()`]
+The `created()` lifecycle callback method is called when an object has just been created using xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`newTransientInstance()`]
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedEvent[`ObjectCreatedEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedEvent[`ObjectCreatedEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_jdo-api.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_jdo-api.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_jdo-api.adoc
index bf159ff..3192f2d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_jdo-api.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_jdo-api.adoc
@@ -13,7 +13,7 @@ As an alternative to relying on Apache Isis to call lifecycle callback methods,
We may decide to deprecate the Apache Isis callbacks in the future because they merely duplicate this functionality already available in JDO.
====
-You can gain access to the relevant JDO API using the xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] domain service.
+You can gain access to the relevant JDO API using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] domain service.
For example:
@@ -46,7 +46,7 @@ public class ObjectChangedListenerService
----
<1> must be `@RequestScoped` because we register on the `PersistenceManager`, which is different for each request.
<2> implement whichever callback lifecycle listeners are of interest
-<3> use the injected xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service to obtain the `PersistenceManager`.
+<3> use the injected xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service to obtain the `PersistenceManager`.
Note that it isn't possible to register on the `PersistenceManagerFactory` because listeners cannot be attached once a persistence session has been created (which it will have been when the service's `@PostConstruct` method is called).
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_loaded.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_loaded.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_loaded.adoc
index a9c5ebd..382c30d 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_loaded.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_loaded.adoc
@@ -11,5 +11,5 @@ The `loaded()` lifecycle callback method is called when a (persistent) object ha
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedEvent[`ObjectLoadedEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedEvent[`ObjectLoadedEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisted.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisted.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisted.adoc
index d885d8d..10c5155 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisted.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisted.adoc
@@ -8,9 +8,9 @@
The `persisted()` lifecycle callback method is called when object has just been persisted from the object store.
-See also xref:rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedEvent[`ObjectPersistedEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedEvent[`ObjectPersistedEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisting.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisting.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisting.adoc
index 0a91570..c6929e2 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisting.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_persisting.adoc
@@ -8,9 +8,9 @@
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:rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingEvent[`ObjectPersistingEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingEvent[`ObjectPersistingEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removed.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removed.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removed.adoc
index ac41176..8b814ff 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removed.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removed.adoc
@@ -8,9 +8,9 @@
The `removed()` lifecycle callback method is called when a (persistent) object has just been deleted from the object store
-See also xref:rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovedEvent[`ObjectRemovedEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovedEvent[`ObjectRemovedEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removing.adoc
index a0da399..ca51dde 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removing.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_removing.adoc
@@ -8,9 +8,9 @@
The `removing()` lifecycle callback method is called when a (persistent) object is just about to be deleted from the object store
-See also xref:rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingEvent[`ObjectRemovingEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingEvent[`ObjectRemovingEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updated.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updated.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updated.adoc
index 244f4be..7f4923e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updated.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updated.adoc
@@ -10,9 +10,9 @@
The `updated()` lifecycle callback method is called when a (persistent) object has just been updated in the object store
-See also xref:rgcms.adoc#_rgcms_methods_lifecycle_updating[`updating()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_updating[`updating()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedEvent[`ObjectUpdatedEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedEvent[`ObjectUpdatedEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updating.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updating.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updating.adoc
index acd535f..d3ffb3a 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updating.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_lifecycle_updating.adoc
@@ -7,9 +7,9 @@
The `updating()` lifecycle callback method is called when a (persistent) object is just about to be updated in the object store
-See also xref:rgcms.adoc#_rgcms_methods_lifecycle_updated[`updated()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_updated[`updated()`].
[TIP]
====
-Alternatively, consider using a xref:rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingEvent[`ObjectUpdatingEvent`].
+Alternatively, consider using a xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[event bus] xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[subscriber] on the xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingEvent[`ObjectUpdatingEvent`].
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes.adoc
index 5eacd97..25cde24 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes.adoc
@@ -34,7 +34,7 @@ The table below lists the method prefixes that are recognized as part of Apache
Param
|Description
-|xref:rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]
|
|
|Y
@@ -47,10 +47,10 @@ Param
Directly mutable collections are not currently supported by the xref:ugvw.adoc#[Wicket viewer].
====
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]`
-|xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`]
|
|Y
|
@@ -58,12 +58,12 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]`
|Y
|Return a list of matching elements for a property or an action parameter. +
-Alternatively, can specify for a class using xref:rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`@DomainObject` +
+Alternatively, can specify for a class using xref:../rgant/rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`@DomainObject` +
`#autoCompleteRepository`] +
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`]
-|xref:rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`]
|
|Y
|
@@ -71,9 +71,9 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`]
|Y
|Provide list of choices for a property or action parameter. +
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`].
-|xref:rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]
|
|Y
|
@@ -83,10 +83,10 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()
Allows business logic to be placed apart from the setter. +
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
-|xref:rgcms.adoc#_rgcms_methods_prefixes_default[`default...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_default[`default...()`]
|
|Y
|
@@ -94,7 +94,7 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
|Y
|Default value for a property or an action parameter.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_disable[`disable...()`]
|Y
|Y
|Y
@@ -102,7 +102,7 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
|
|Disables (makes read-only) a property, a collection or an action.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_get[`get...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_get[`get...()`]
|
|Y
|Y
@@ -110,9 +110,9 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
|
|Access the value of a property or collection. +
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
-|xref:rgcms.adoc#_rgcms_methods_prefixes_hide[`hide...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_hide[`hide...()`]
|
|Y
|Y
@@ -120,7 +120,7 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
|
|Hides a property, a collection or an action.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]
|
|Y
|
@@ -130,9 +130,9 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
Allows business logic to be placed apart from the setter. +
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]`.
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]`.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]
|
|
|Y
@@ -145,10 +145,10 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]`.
Directly mutable collections are not currently supported by the xref:ugvw.adoc#[Wicket viewer].
====
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]`
-|xref:rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`]
|
|Y
|Y
@@ -156,7 +156,7 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]`
|
|Sets the value of a property or a collection.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`]
|Y
|
|
@@ -164,9 +164,9 @@ See also xref:rgcms.adoc#_rgcms_methods_prefixes_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:rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`] and xref:rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`] to validate modifications to collections.
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`] to validate modifications to collections.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validate +
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validate +
AddTo...()`]
|
|Y
@@ -180,9 +180,9 @@ AddTo...()`]
Directly mutable collections are not currently supported by the xref:ugvw.adoc#[Wicket viewer].
====
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`], and xref:rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`] for properties and actions.
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`], and xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`] for properties and actions.
-|xref:rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validate +
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validate +
RemoveFrom...()`]
|
|Y
@@ -196,7 +196,7 @@ RemoveFrom...()`]
Directly mutable collections are not currently supported by the xref:ugvw.adoc#[Wicket viewer].
====
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`], and xref:rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`] for properties and actions.
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`], and xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validate[`validate...()`] for properties and actions.
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_addTo.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_addTo.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_addTo.adoc
index 14b570d..5ab34de 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_addTo.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_addTo.adoc
@@ -34,4 +34,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_autoComplete.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_autoComplete.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_autoComplete.adoc
index ca0f1cb..4536425 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_autoComplete.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_autoComplete.adoc
@@ -10,7 +10,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:rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`] supporting method instead.
+If the number of candidate objects is comparatively small, then use xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_choices[`choices...()`] supporting method instead.
====
The signature of the supporting method depends on whether it is for a parameter or a property.
@@ -58,7 +58,7 @@ public class ShoppingCartItem {
}
----
<1> `product` is the 0th argument of the action.
-<2> the xref:rgant.adoc#_rgant-MinLength[`@MinLength`] annotation specifies the minimum number of characters that must be entered before a search is performed for matching objects
+<2> the xref:../rgant/rgant.adoc#_rgant-MinLength[`@MinLength`] annotation specifies the minimum number of characters that must be entered before a search is performed for matching objects
@@ -91,6 +91,6 @@ public class ShoppingCartItem {
...
}
----
-<1> the xref:rgant.adoc#_rgant-MinLength[`@MinLength`] annotation specifies the minimum number of characters that must be entered before a search is performed for matching objects
+<1> the xref:../rgant/rgant.adoc#_rgant-MinLength[`@MinLength`] annotation specifies the minimum number of characters that must be entered before a search is performed for matching objects
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_choices.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_choices.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_choices.adoc
index dd4f094..8f7d980 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_choices.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_choices.adoc
@@ -6,7 +6,7 @@
-The `choices...()` supporting method is called for both action parameters and for properties, to find objects from a drop-down list box. Unlike xref:rgcms.adoc#_rgcms_methods_prefixes_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:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_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.
@@ -60,7 +60,7 @@ image::{_imagesdir}reference-methods/prefixes/choices/dependent.png[width="800px
-This functionality is actually implemented as a xref:ugfun.adoc#_ugfun_how-tos_contributed-members[contributed action], so the code for this is:
+This functionality is actually implemented as a xref:../ugfun/ugfun.adoc#_ugfun_how-tos_contributed-members[contributed action], so the code for this is:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_clear.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_clear.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_clear.adoc
index 312a946..a70856e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_clear.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_clear.adoc
@@ -29,4 +29,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_modify[`modify...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_default.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_default.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_default.adoc
index 24ecfff..a3f0e81 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_default.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_default.adoc
@@ -8,7 +8,7 @@
The `default...()` supporting method is called for action parameters to return the initial argument value. This may be some sensible default (eg today's date, or 0 or 1), or -- for an action that is modifying the state of an object -- might default to the current value of a corresponding property.
-The method is _also_ called for properties in the case when an object is newly instantiated using xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`]. This is a much less common use case. If a default is not specified then properties are initialized to a default based on their type (eg 0 or `false`).
+The method is _also_ called for properties in the case when an object is newly instantiated using xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`]. This is a much less common use case. If a default is not specified then properties are initialized to a default based on their type (eg 0 or `false`).
The signature of the supporting method depends on whether it is for an action parameter or a property.
@@ -58,7 +58,7 @@ public class ShoppingCartItem {
-Defaults are also supported (of course) for xref:ugfun.adoc#_ugfun_how-tos_contributed-members[contributed actions]. For example, here is a contributed action for updating category/subcategory of the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]:
+Defaults are also supported (of course) for xref:../ugfun/ugfun.adoc#_ugfun_how-tos_contributed-members[contributed actions]. For example, here is a contributed action for updating category/subcategory of the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]:
[source,java]
----
@@ -123,7 +123,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:rgcms.adoc#_rgcms_methods_lifecycle_created[`created()`] callback, called by the framework when xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`] is called. This method is called after any dependencies have been injected into the service.
+The first is to use the xref:../rgcms/rgcms.adoc#_rgcms_methods_lifecycle_created[`created()`] callback, called by the framework when xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer#newTransientInstance(...)`] is called. This method is called after any dependencies have been injected into the service.
The second is more straightforward: simply initialize properties in the constructor. However, this cannot use any injected services as they will not have been initialized.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_disable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_disable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_disable.adoc
index c1869ae..16ca889 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_disable.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_disable.adoc
@@ -89,6 +89,6 @@ public class Customer {
In the case of actions, the framework will also search for supporting method that has the exact same parameter types as the action itself.
Enabling `isis.reflector.validator.noParamsOnly` configuration property switches this off, so that the framework will only search for supporting method with no parameters.
-Note that enabling this configuration property in effect means that xref:rgcms.adoc#_rgcms_classes_mixins[mixins] must be used instead of xref:ugbtb.adoc#_ugbtb_decoupling_contributions[contributed services] (because contributed actions are the one case where the value of a parameter to a supporting method may be non-null).
+Note that enabling this configuration property in effect means that xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins[mixins] must be used instead of xref:ugbtb.adoc#_ugbtb_decoupling_contributions[contributed services] (because contributed actions are the one case where the value of a parameter to a supporting method may be non-null).
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_get.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_get.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_get.adoc
index 977a149..0923c86 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_get.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_get.adoc
@@ -15,5 +15,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:rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_set[`set...()`].
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_hide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_hide.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_hide.adoc
index 214e580..7566041 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_hide.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_hide.adoc
@@ -9,7 +9,7 @@
The `hide...()` supporting method is called for properties, collections and actions.
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:rgcms.adoc#_rgcms_methods_prefixes_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:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_disable[disabled], ie greyed out).
The signature of the supporting method is simply:
@@ -65,6 +65,6 @@ public class Customer {
In the case of actions, the framework will also search for supporting method that has the exact same parameter types as the action itself.
Enabling `isis.reflector.validator.noParamsOnly` configuration property switches this off, so that the framework will only search for supporting method with no parameters.
-Note that enabling this configuration property in effect means that xref:rgcms.adoc#_rgcms_classes_mixins[mixins] must be used instead of xref:ugbtb.adoc#_ugbtb_decoupling_contributions[contributed services] (because contributed actions are the one case where the value of a parameter to a supporting method may be non-null).
+Note that enabling this configuration property in effect means that xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins[mixins] must be used instead of xref:ugbtb.adoc#_ugbtb_decoupling_contributions[contributed services] (because contributed actions are the one case where the value of a parameter to a supporting method may be non-null).
====
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_modify.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_modify.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_modify.adoc
index 53a1c87..bc41a70 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_modify.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_modify.adoc
@@ -32,6 +32,6 @@ public class LibraryMember {
<3> perform some additional business logic
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_clear[`clear...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_removeFrom.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_removeFrom.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_removeFrom.adoc
index 5a965f2..e7e07fa 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_removeFrom.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_removeFrom.adoc
@@ -34,4 +34,4 @@ public class LibraryMember {
<2> perform some additional business logic
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_set.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_set.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_set.adoc
index a143d22..cb2ffbf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_set.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_set.adoc
@@ -10,4 +10,4 @@
The `set...()` prefix is simply the normal JavaBean setter prefix that denotes writeable properties or collections.
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_get[`get...()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_get[`get...()`].
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateAddTo.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateAddTo.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateAddTo.adoc
index 795d152..afb2550 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateAddTo.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateAddTo.adoc
@@ -41,5 +41,5 @@ public class LibraryMember {
----
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`] and xref:rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_addTo[`addTo...()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateRemoveFrom[`validateRemoveFrom...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateRemoveFrom.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateRemoveFrom.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateRemoveFrom.adoc
index d8f5a2e..acbd98e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateRemoveFrom.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_prefixes_validateRemoveFrom.adoc
@@ -41,5 +41,5 @@ public class LibraryMember {
----
-See also xref:rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`] and xref:rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`]`
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_removeFrom[`removeFrom...()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_validateAddTo[`validateAddTo...()`]`
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved.adoc
index 90cb286..929b5ec 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved.adoc
@@ -15,33 +15,33 @@ The table below lists the reserved methods that are recognized as part of Apache
|Method
|Description
-|xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
-|Provides a CSS class for this object instance. In conjunction with xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
+|Provides a CSS class for this object instance. In conjunction with xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
-See also xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`].
-|xref:rgcms.adoc#_rgcms_methods_reserved_disable[`disable(...)`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_disable[`disable(...)`]
|Disable all or some of an object's properties
-|xref:rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`]
|Provides an optional unique identifier of a service. +
If not provided, the service's fully-qualified class name is used.
-|xref:rgcms.adoc#_rgcms_methods_reserved_hide[`hide(...)`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_hide[`hide(...)`]
|Hide all or some of an object's properties
-|xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_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. +
-See also xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
-|xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`]
|Provides a title for the object. +
-See also xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] and xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
-|xref:rgcms.adoc#_rgcms_methods_reserved_validate[`validate()`]
+|xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_validate[`validate()`]
|Validate the object's state prior to persisting.
|===
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_cssClass.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_cssClass.adoc
index 9bd36a2..12ac2eb 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_cssClass.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_cssClass.adoc
@@ -10,7 +10,7 @@ The `cssClass()` returns a CSS class for a particular object instance.
The xref:ugvw.adoc#[Wicket viewer] wraps the object's representation in a containing `<div>` with the class added. This is done both for rendering the object either in a table or when rendering the object on its own page.
-In conjunction with xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
+In conjunction with xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`], can therefore provide custom styling of an object instance wherever it is rendered. +
For example, the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp] uses this technique to add a strikethrough for completed todo items. This is shown on the home page:
@@ -30,7 +30,7 @@ public class ToDoItem ... {
}
----
-In the xref:rgcfg.adoc#_rgcfg_application-specific_application-css[application.css], the following styles were then added:
+In the xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[application.css], the following styles were then added:
[source,css]
----
@@ -43,4 +43,4 @@ tr.done {
----
-See also xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`].
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`].
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_disable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_disable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_disable.adoc
index 35ff008..765062b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_disable.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_disable.adoc
@@ -7,7 +7,7 @@
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:rgcms.adoc#_rgcms_methods_prefixes_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:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_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:
@@ -31,7 +31,7 @@ public String disable(Identifier.Type identifierType) {
}
----
-See also the similar methods to xref:rgcms.adoc#_rgcms_methods_reserved_hide[`hide()`] object members en-masse.
+See also the similar methods to xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_hide[`hide()`] object members en-masse.
== Alternatives
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
index 7a6aa39..4d2d081 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_getId.adoc
@@ -11,8 +11,8 @@ This value is used internally to generate a string representation of an service
This can appear in several contexts, including:
* as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark`
- (see xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`])
-* in the serialization of `OidDto` in the xref:rgcms.adoc#_rgcms_schema-cmd[command] and xref:rgcms.adoc#_rgcms_schema-ixn[interaction] schemas
+ (see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`])
+* in the serialization of `OidDto` in the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] and xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction] schemas
* in the URLs of the xref:ugvro.adoc#[RestfulObjects viewer]
* in the URLs of the xref:ugvw.adoc#[Wicket viewer] (specifically, for bookmarked actions)
@@ -37,8 +37,8 @@ public class OrderMenu {
The rules of precedence are:
-1. xref:rgant.adoc#_rgant_DomainService_objectType[`@DomainService#objectType()`]
-2. xref:rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`]
+1. xref:../rgant/rgant.adoc#_rgant_DomainService_objectType[`@DomainService#objectType()`]
+2. xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`]
3. The fully qualified class name.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_hide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_hide.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_hide.adoc
index c1da611..d23963c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_hide.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_hide.adoc
@@ -8,7 +8,7 @@
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:rgcms.adoc#_rgcms_methods_prefixes_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:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_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:rgcms.adoc#_rgcms_methods_reserved_disable[`disable()`] object members en-masse.
+See also the similar method to xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_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:rgcms.adoc#_rgcms_methods_reserved_disable[here].
+There is further discussion on this approach in xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_disable[here].
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_iconName.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_iconName.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_iconName.adoc
index 3f235eb..9f5a97e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_iconName.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_iconName.adoc
@@ -33,4 +33,4 @@ public class ToDoItem ... {
}
----
-See also xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_title.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_title.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_title.adoc
index f592ff0..bd64f0e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_title.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods_reserved_title.adoc
@@ -40,17 +40,17 @@ public String title() {
return buf.toString();
}
----
-<1> simple xref:rgcms.adoc#_rgcms_classes_utility_TitleBuffer[tility class] to help construct the title string
+<1> simple xref:../rgcms/rgcms.adoc#_rgcms_classes_utility_TitleBuffer[tility class] to help construct the title string
<2> imperative conditional logic
-<3> using the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] to determine if the `dueBy` field is visible for this user ...
+<3> using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] to determine if the `dueBy` field is visible for this user ...
<4> ... but ignore if not
As the example above shows, the implementation can be as complex as you like.
-In many cases, though, you may be able to use the xref:rgant.adoc#_rgant-Title[`@Title`] annotation.
+In many cases, though, you may be able to use the xref:../rgant/rgant.adoc#_rgant-Title[`@Title`] annotation.
-See also xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] and xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
+See also xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] and xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`]
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-aim.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-aim.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-aim.adoc
index 42bd442..bf80369 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-aim.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-aim.adoc
@@ -10,15 +10,15 @@ The "aim" schema defines the serialized form (or memento) of an action invocatio
[WARNING]
====
-This schema has been removed in `1.13.0`, replaced with xref:rgcms.adoc#_rgcms_schema-ixn[ixn.xsd] (for action
-invocations/property edits) and with xref:rgcms.adoc#_rgcms_schema-cmd[cmd.xsd] (commands, ie the __intention__ to
+This schema has been removed in `1.13.0`, replaced with xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[ixn.xsd] (for action
+invocations/property edits) and with xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[cmd.xsd] (commands, ie the __intention__ to
invoke an action/edit a property).
The remaining content on this page describes how `CommandContext` works up to v1.12.x. However, as of `1.13.0` the `CommandContext` uses its own `cmd.xsd` schema).
====
Action invocations are captured (in memory rather than in serialized form) when the end-user invokes the action
-"through" the UI, by way of the xref:rgsvc.adoc#_rgsvc_api_CommandContext[CommandContext] service. Using the
+"through" the UI, by way of the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[CommandContext] service. Using the
`ActionInvocationMementoDtoUtils` utility class, a service can instantiate `ActionInvocationMementoDto` which can then
be serialized to/from using the same `ActionInvocationMementoDtoUtils` class.
@@ -83,12 +83,12 @@ be serialized to/from using the same `ActionInvocationMementoDtoUtils` class.
</xs:schema>
----
<1> the aim schema has a namespace URI of "http://isis.apache.org/schema/aim". Although URIs are not the same as URLs, you will find that the schemas are also downloadable from this location.
-<2> reuses the xref:rgcms.adoc#_rgcms_schema-common[common] schema
+<2> reuses the xref:../rgcms/rgcms.adoc#_rgcms_schema-common[common] schema
<3> definition of the `actionInvocationMementoDto` complex type. This consists of metadata (the transaction identifier, the target object, the initiating user) and the payload (the action parameter/arguments, the return value if known).
<4> the unique transaction Id (a guid) allocated by the framework for each and every transaction
<5> a sequence number within the transaction. It is possible for there to be more than one action invocation to be
<6> when the action was invoked
-<7> target object, as an OID (using `oidDto` from the xref:rgcms.adoc#_rgcms_schema-common[common] schema)
+<7> target object, as an OID (using `oidDto` from the xref:../rgcms/rgcms.adoc#_rgcms_schema-common[common] schema)
<8> fully qualified class name of the target object, for information only
<9> name of the action, for information only
<10> Javadoc style unique identifier for the action.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
index 8901332..9f4bc7b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-chg.adoc
@@ -11,8 +11,8 @@ updated or deleted as the result of invoking an action or editing a property. I
metrics counts (number of objects loaded, number of object properties modified), useful for profiling.
An instance of the DTO (corresponding to this schema) is used within the
-xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] SPI, identifying changed objects that are to be
-published (as per xref:rgant.adoc#_rgant_DomainObject_publishing[`@DomainObject#publishing()`] or equivalent).
+xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`] SPI, identifying changed objects that are to be
+published (as per xref:../rgant/rgant.adoc#_rgant_DomainObject_publishing[`@DomainObject#publishing()`] or equivalent).
== `changesDto`
@@ -51,12 +51,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:rgcms.adoc#_rgcms_schema_common["common" schema].
+<2> uses complex types defined in the xref:../rgcms/rgcms.adoc#_rgcms_schema_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:rgcms.adoc#_rgcms_schema_command[command] that represented the intention to perform this
-execution, as well as to the xref:rgcms.adoc#_rgcms_schema_interaction[interaction] that executes said command.
+correlate back to the xref:../rgcms/rgcms.adoc#_rgcms_schema_command[command] that represented the intention to perform this
+execution, as well as to the xref:../rgcms/rgcms.adoc#_rgcms_schema_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.
@@ -93,5 +93,5 @@ 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:rgcms.adoc#_rgcms_schema_ixn[interaction] schema also provides metrics on the number of objects loaded/changed,
+The xref:../rgcms/rgcms.adoc#_rgcms_schema_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.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-cmd.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-cmd.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-cmd.adoc
index 2adcd16..4af6e86 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-cmd.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-cmd.adoc
@@ -51,12 +51,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:rgcms.adoc#_rgcms_schema_common["common" schema].
+<2> uses complex types defined in the xref:../rgcms/rgcms.adoc#_rgcms_schema_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:rgcms.adoc#_rgcms_schema_interaction[interaction] that executes the command, and to any
-xref:rgcms.adoc#_rgcms_schema_changes[changes] to domain objects occurring as a side-effect of that interaction.
+to the xref:../rgcms/rgcms.adoc#_rgcms_schema_interaction[interaction] that executes the command, and to any
+xref:../rgcms/rgcms.adoc#_rgcms_schema_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. As of `1.13.0`, a bulk action will create multiple commands,
each with only a single target, but a future version of the framework may also support a single bulk command against
@@ -110,11 +110,11 @@ property. The `actionDto` and `propertyDto` are the concrete subtypes:
property).
<2> the `interactionType` attribute indicates whether the member is an action or a property.
<3> 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:rgcms.adoc#__rgcms_schema-cmd_ancillary[below].
+invoke the action. The `paramsDto` type is defined xref:../rgcms/rgcms.adoc#__rgcms_schema-cmd_ancillary[below].
<4> the `propertyDto` complex type captures the new value (possibly `null`) to set the property to.
-Note also that there is a corresponding xref:rgcms.adoc#__rgcms_schema-ixn_memberExecutionDto[`memberExecutionDto`]
+Note also that there is a corresponding xref:../rgcms/rgcms.adoc#__rgcms_schema-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).
@@ -147,4 +147,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:rgcms.adoc#_rgcms_schema-common["common"] schema.
+xref:../rgcms/rgcms.adoc#_rgcms_schema-common["common"] schema.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-common.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-common.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-common.adoc
index 9191358..d3411a1 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-common.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-common.adoc
@@ -12,11 +12,11 @@ The "common" schema defines a number of complex types that are used by other hig
== `oidDto`
The `oidDto` complex type captures an object's type and its identifier. This is basically a formal XML equivalent to
-the `Bookmark` object obtained from the xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`].
+the `Bookmark` object obtained from the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`].
Although simple, this is an enormously powerful concept, in that it represents a URI to any domain object managed by
a given Apache Isis application. With it, we have the ability to lookup any arbitrary object. Further discussion and
-examples can be found xref:ugfun.adoc#__ugfun_core-concepts_building-blocks_oid[here].
+examples can be found xref:../ugfun/ugfun.adoc#__ugfun_core-concepts_building-blocks_oid[here].
The `oidDto` complex type is defined as:
@@ -55,15 +55,15 @@ URLs, you will find that the schemas are also downloadable from this location.
<2> the `oidDto` complex type defines the unique identifier for any domain object: its type, and an identifier. The
`objectState` attribute can usually be omitted (indicating a persistent object)
<3> the object type, corresponding to either the
-xref:rgant.adoc#_rgant-DomainObject_objectType[`@DomainObject#objectType()`] attribute, or to the (JDO)
-xref:rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`] annotation (`schema` and/or `table`
-attributes), or to the (JDO) xref:rgant.adoc#_rgant-Discriminator[`@Discriminator`] annotation. If none
+xref:../rgant/rgant.adoc#_rgant-DomainObject_objectType[`@DomainObject#objectType()`] attribute, or to the (JDO)
+xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`] annotation (`schema` and/or `table`
+attributes), or to the (JDO) xref:../rgant/rgant.adoc#_rgant-Discriminator[`@Discriminator`] annotation. If none
is specified, then the fully qualified class name will be used.
<4> the object identifier (aka primary key), converted to string form.
<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:rgcms.adoc#_rgcms_schema_cmd["cmd" schema] to represent the
+<6> Models a list of OIDs. This is used by the xref:../rgcms/rgcms.adoc#_rgcms_schema_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
@@ -72,17 +72,17 @@ modelled as an element rather than an attribute. The element form can still be
The `oidDto` complex type is used in a number of places by the framework:
* first, as a means of serializing JAXB view model/DTOs (annotated with
-xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]), that reference domain entities. +
+xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]), that reference domain entities. +
+
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:rgcms.adoc#_rgcms_schema-cmd["cmd" (command)] schema. +
+as described by the xref:../rgcms/rgcms.adoc#_rgcms_schema-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:rgcms.adoc#_rgcms_schema-ixn["ixn" (interaction)] schema.
+property edit, as described by the xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn["ixn" (interaction)] schema.
[[__rgcms_schema-common_valueDto]]
@@ -139,7 +139,7 @@ invocations, and for the new value in property edits.
These type definitions are just building blocks, also used within the
-xref:rgcms.adoc#_rgcms_schema-aim[action iInvocation memento] schema. The first, `valueDto` is The second, `valueType`, enumerates the different types of vales, eg of a
+xref:../rgcms/rgcms.adoc#_rgcms_schema-aim[action iInvocation memento] schema. The first, `valueDto` is The second, `valueType`, enumerates the different types of vales, eg of a
formal parameter to an action.
@@ -148,7 +148,7 @@ formal parameter to an action.
== 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:rgcms.adoc#_rgcms_schema_cmd["cmd"] and xref:rgcms.adoc#_rgcms_schema_ixn["ixn"] schemas.
+the xref:../rgcms/rgcms.adoc#_rgcms_schema_cmd["cmd"] and xref:../rgcms/rgcms.adoc#_rgcms_schema_ixn["ixn"] schemas.
[source,xml]
----
@@ -187,5 +187,5 @@ the xref:rgcms.adoc#_rgcms_schema_cmd["cmd"] and xref:rgcms.adoc#_rgcms_schema_i
<2> Captures a period of time, eg for capturing metrics/timings.
<3> Captures a pair of numbers representing a difference. Used for example to capture metrics (number objects modified before and after).
<4> Whether this command/interaction with a member is invoking an action, or editing a property. Used by both the
-xref:rgcms.adoc#_rgcms_schema_cmd["cmd"] and xref:rgcms.adoc#_rgcms_schema_ixn["ixn"] schemas.
+xref:../rgcms/rgcms.adoc#_rgcms_schema_cmd["cmd"] and xref:../rgcms/rgcms.adoc#_rgcms_schema_ixn["ixn"] schemas.
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-ixn.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-ixn.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-ixn.adoc
index 16250ed..866a894 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-ixn.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema-ixn.adoc
@@ -8,7 +8,7 @@
The interaction ("ixn") schema defines the serialized form of an action invocation or a property
edit. In fact, it actually defines a call-graph of such executions for those cases where the
-xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] is used to execute sub-actions/property edits.
+xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`] is used to execute sub-actions/property edits.
Each execution identifies the target object, the member to invoke, and the arguments. It also captures metrics about
the execution, and the result of the execution (eg return value of an action invocation).
@@ -57,13 +57,13 @@ 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:rgcms.adoc#_rgcms_schema_common["common" schema] and also the
-xref:rgcms.adoc#_rgcms_schema_cmd["cmd" schema]
+<2> uses complex types defined in the xref:../rgcms/rgcms.adoc#_rgcms_schema_common["common" schema] and also the
+xref:../rgcms/rgcms.adoc#_rgcms_schema_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:rgcms.adoc#_rgcms_schema_command[command] that represented the intention to perform this
-execution, as well as to any xref:rgcms.adoc#_rgcms_schema_changes[changes] to domain objects that occur as a side-effect
+correlate back to the xref:../rgcms/rgcms.adoc#_rgcms_schema_command[command] that represented the intention to perform this
+execution, as well as to any xref:../rgcms/rgcms.adoc#_rgcms_schema_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.
@@ -76,7 +76,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:rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`] of the "cmd" schema;
+of a property. It corresponds to the xref:../rgcms/rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`] of the "cmd" schema;
some elements are copied directly:
[source,xml]
@@ -111,13 +111,13 @@ some elements are copied directly:
<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:rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
-<4> the member identifier; corresponds to `memberIdentifier` of the `member` element of the xref:rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
-<5> the user executing the action invocation/property edit; corresponds to the `user` element of the xref:rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
+<3> the target object, corresponding to one of the elements of the `targets` element of the xref:../rgcms/rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
+<4> the member identifier; corresponds to `memberIdentifier` of the `member` element of the xref:../rgcms/rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
+<5> the user executing the action invocation/property edit; corresponds to the `user` element of the xref:../rgcms/rgcms.adoc#__rgcms_schema-cmd_memberDto[`memberDto`]
<6> the current "human-friendly" title of the target object
-<7> the set of metrics captured for this execution, of type `metricsDto` defined xref:rgcms.adoc#__rgcms_schema-ixn_ancillary[below].
+<7> the set of metrics captured for this execution, of type `metricsDto` defined xref:../rgcms/rgcms.adoc#__rgcms_schema-ixn_ancillary[below].
<8> if the action invocation/property edit threw an exception, then this is captured here.
-<9> if any sub-actions or sub-edits were performed via the xref:rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`], then these are captured in the `childExecutions` element.
+<9> if any sub-actions or sub-edits were performed via the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`], then these are captured in the `childExecutions` element.
<10> the `interactionType` attribute indicates whether the member is an action or a property (similar attribute exists for the "cmd" schema).
@@ -154,13 +154,13 @@ The `actionInvocationDto` and `propertyEditDto` are the concrete subtypes:
</xs:schema>
----
<1> the `actionInvocationDto` inherits from `memberExecutionDto`. It corresponds to the similar
-xref:rgcms.adoc#__rgcms_schema-cmd_memberDto[`actionDto`] complex type of the "cmd" schema
+xref:../rgcms/rgcms.adoc#__rgcms_schema-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:rgcms.adoc#__rgcms_schema-cmd_memberDto[`propertyDto`] complex type of the "cmd" schema
+xref:../rgcms/rgcms.adoc#__rgcms_schema-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.
@@ -204,5 +204,5 @@ to the database). Together these metrics give an idea of the "size" of this pa
<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:rgcms.adoc#_rgcms_schema_changes[changes] schema also provides metrics on the number of objects loaded/changed,
+The xref:../rgcms/rgcms.adoc#_rgcms_schema_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
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema.adoc
index 2a2c0ef..831dd26 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_schema.adoc
@@ -9,18 +9,18 @@ Most applications need to integrate with other apps in the enterprise. To facil
Apache Isis defines a number of standard XSD schemas:
-* the xref:rgcms.adoc#_rgcms_schema-cmd[command] schema, which captures the __intention__ of a user
+* the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] schema, which captures the __intention__ of a user
to invoke an action or edit a property
-* the xref:rgcms.adoc#_rgcms_schema-ixn[interaction execution] schema, which captures the actual execution of an action invocation/property edit
+* the xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction execution] schema, which captures the actual execution of an action invocation/property edit
-* the xref:rgcms.adoc#_rgcms_schema-chg[changes] schema, which captures which objects have been
+* the xref:../rgcms/rgcms.adoc#_rgcms_schema-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
-* the xref:rgcms.adoc#_rgcms_schema-aim[action memento invocation] schema (deprecated in `1.13.0`, replaced by
+* the xref:../rgcms/rgcms.adoc#_rgcms_schema-aim[action memento invocation] schema (deprecated in `1.13.0`, replaced by
either "cmd" or "ixn"), which allows action invocations to be captured and reified.
-These each use XSD types defined by the xref:rgcms.adoc#_rgcms_schema-common[common schema] (most notably the `oidDto`
+These each use XSD types defined by the xref:../rgcms/rgcms.adoc#_rgcms_schema-common[common schema] (most notably the `oidDto`
complex type which identifies a domain object).
The (non-ASF) http://github.com/isisaddons/isis-module-command[Isis addons' command] and
http://git-wip-us.apache.org/repos/asf/isis/blob/d601f195/adocs/documentation/src/main/asciidoc/guides/rgcms/rgcms.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/rgcms.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/rgcms.adoc
index ba6e1ad..30372e9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms/rgcms.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/rgcms.adoc
@@ -10,10 +10,10 @@
== Classes, Methods and Schema
This reference guide lists and describes various elements of the the Apache Isis Programming Model, specifically
-reserved and prefix xref:rgcms.adoc#_rgcms_methods[methods] (such as `title()` and `validate...()`) and various utility and
-supporting xref:rgcms.adoc#_rgcms_classes[classes].
+reserved and prefix xref:../rgcms/rgcms.adoc#_rgcms_methods[methods] (such as `title()` and `validate...()`) and various utility and
+supporting xref:../rgcms/rgcms.adoc#_rgcms_classes[classes].
-It also describes the xref:rgcms.adoc#_rgcms_schema[XSD schema] defined by Apache Isis. One use case is for the
+It also describes the xref:../rgcms/rgcms.adoc#_rgcms_schema[XSD schema] defined by Apache Isis. One use case is for the
JAXB serialization of view models.
=== Other Guides