You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by mg...@apache.org on 2015/12/13 15:31:23 UTC
[16/52] [abbrv] isis git commit: ISIS-1243: removing manpage from
.adoc file names.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n.adoc
index c6c2fcf..65f0932 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n.adoc
@@ -8,4 +8,4 @@
The `org.apache.isis.applib.services.i18n` package contains a single class to support i18n.
-include::_rgcms_classes_i18n_manpage-TranslatableString.adoc[leveloffset=+1]
+include::_rgcms_classes_i18n_TranslatableString.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_TranslatableString.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_TranslatableString.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_TranslatableString.adoc
new file mode 100644
index 0000000..311cbca
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_TranslatableString.adoc
@@ -0,0 +1,13 @@
+[[_rgcms_classes_i18n_TranslatableString]]
+= `TranslatableString`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+IMPORTANT: TODO - see xref:ugbtb.adoc#_ugbtb_more-advanced_i18n[user guide, i18n].
+
+The `TranslatableString` utility class ...
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_manpage-TranslatableString.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_manpage-TranslatableString.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_manpage-TranslatableString.adoc
deleted file mode 100644
index 9611a1e..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_i18n_manpage-TranslatableString.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
-[[_rgcms_classes_i18n_manpage-TranslatableString]]
-= `TranslatableString`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-IMPORTANT: TODO - see xref:ugbtb.adoc#_ugbtb_more-advanced_i18n[user guide, i18n].
-
-The `TranslatableString` utility class ...
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent.adoc
index cd99543..2ad3836 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent.adoc
@@ -22,7 +22,7 @@ Impl'n (g: a:)
|Notes
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`o.a.i.applib.` +
`AbstractLifecycleEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -31,7 +31,7 @@ Impl'n (g: a:)
|Superclass of the other lifecycle events, listed below in this table.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectCreatedDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedDomainEvent[`o.a.i.applib.` +
`ObjectCreatedEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -43,7 +43,7 @@ using the xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-creation-api[`
`#newTransientInstance(...)` method.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectLoadedDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedDomainEvent[`o.a.i.applib.` +
`ObjectLoadedEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -53,7 +53,7 @@ using the xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-creation-api[`
|Broadcast when an object is retrieved from the database.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectPersistedDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedDomainEvent[`o.a.i.applib.` +
`ObjectPersistedEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -65,7 +65,7 @@ xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainO
`#persist(...)` method.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectPersistingDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingDomainEvent[`o.a.i.applib.` +
`ObjectPersistingEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -77,7 +77,7 @@ xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainO
`#persist(...)` method.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectRemovingDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingDomainEvent[`o.a.i.applib.` +
`ObjectRemovingEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -89,7 +89,7 @@ xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainO
`#remove(...)` method.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedDomainEvent[`o.a.i.applib.` +
`ObjectUpdatedEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -102,7 +102,7 @@ xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainO
`#flush(...)` method, else is done implicitly when the transaction commits at the end of the user request.
-|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingDomainEvent[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingDomainEvent[`o.a.i.applib.` +
`ObjectUpdatingEvent`]
|``o.a.i.core`` +
``services.eventbus`` +
@@ -119,12 +119,12 @@ xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainO
-include::_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc[leveloffset=+1]
+include::_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc
new file mode 100644
index 0000000..6ed5f80
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc
@@ -0,0 +1,27 @@
+[[_rgcms_classes_lifecycleevent_AbstractLifecycleEvent]]
+= `AbstractLifecycleEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+This class is the superclass for all lifecycle events that are raised by the framework when loading, saving, updating
+or deleting objects from the database.
+
+Its immediate subclasses are:
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedEvent[`ObjectCreatedEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedEvent[`ObjectLoadedEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedEvent[`ObjectPersistedEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingEvent[`ObjectPersistingEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingEvent[`ObjectRemovingEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedEvent[`ObjectUpdatedEvent`]
+
+* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingEvent[`ObjectUpdatingEvent`]
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
new file mode 100644
index 0000000..3db2610
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc
@@ -0,0 +1,20 @@
+[[_rgcms_classes_lifecycleevent_ObjectCreatedEvent]]
+= `ObjectCreatedEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+
+Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
+when an object is first instantiated using the
+xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
+`#newTransientInstance(...)` method.
+
+`ObjectCreatedEvent.Default` is the concrete implementation that is used.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
new file mode 100644
index 0000000..936e750
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc
@@ -0,0 +1,17 @@
+[[_rgcms_classes_lifecycleevent_ObjectLoadedEvent]]
+= `ObjectLoadedEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+
+Subclass of xref: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.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
new file mode 100644
index 0000000..1973b28
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc
@@ -0,0 +1,19 @@
+[[_rgcms_classes_lifecycleevent_ObjectPersistedEvent]]
+= `ObjectPersistedEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
+when an object is first saved (inserted) into the database using the
+xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+`#persist(...)` method.
+
+
+`ObjectPersistedEvent.Default` is the concrete implementation that is used.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
new file mode 100644
index 0000000..4828a53
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc
@@ -0,0 +1,21 @@
+[[_rgcms_classes_lifecycleevent_ObjectPersistingEvent]]
+= `ObjectPersistingEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
+when an object is about to be saved (inserted) into the database using the
+xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+`#persist(...)` method.
+
+
+`ObjectPersistingEvent.Default` is the concrete implementation that is used.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
new file mode 100644
index 0000000..7335583
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc
@@ -0,0 +1,20 @@
+[[_rgcms_classes_lifecycleevent_ObjectRemovingEvent]]
+= `ObjectRemovingEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
+when an object is about to be deleted from the database using the
+xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
+`#remove(...)` method.
+
+
+`ObjectRemovingEvent.Default` is the concrete implementation that is used.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
new file mode 100644
index 0000000..6989e72
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc
@@ -0,0 +1,21 @@
+[[_rgcms_classes_lifecycleevent_ObjectUpdatedEvent]]
+= `ObjectUpdatedEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+
+Subclass of xref: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.adoc#_rgsvc-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.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
new file mode 100644
index 0000000..8554ff7
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc
@@ -0,0 +1,22 @@
+[[_rgcms_classes_lifecycleevent_ObjectUpdatingEvent]]
+= `ObjectUpdatingEvent`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+
+Subclass of xref: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.adoc#_rgsvc-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.
+
+[NOTE]
+====
+In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
+====
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent.adoc
deleted file mode 100644
index 590c85c..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent.adoc
+++ /dev/null
@@ -1,27 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent]]
-= `AbstractLifecycleEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-This class is the superclass for all lifecycle events that are raised by the framework when loading, saving, updating
-or deleting objects from the database.
-
-Its immediate subclasses are:
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent[`ObjectCreatedEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent[`ObjectLoadedEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent[`ObjectPersistedEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent[`ObjectPersistingEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent[`ObjectRemovingEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent[`ObjectUpdatedEvent`]
-
-* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent[`ObjectUpdatingEvent`]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent.adoc
deleted file mode 100644
index 788a628..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent.adoc
+++ /dev/null
@@ -1,20 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectCreatedEvent]]
-= `ObjectCreatedEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is first instantiated using the
-xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s
-`#newTransientInstance(...)` method.
-
-`ObjectCreatedEvent.Default` is the concrete implementation that is used.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent.adoc
deleted file mode 100644
index 7d65cf7..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectLoadedEvent]]
-= `ObjectLoadedEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is retrieved from the database.
-
-`ObjectLoadedEvent.Default` is the concrete implementation that is used.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent.adoc
deleted file mode 100644
index 95bd2e8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectPersistedEvent]]
-= `ObjectPersistedEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is first saved (inserted) into the database using the
-xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
-`#persist(...)` method.
-
-
-`ObjectPersistedEvent.Default` is the concrete implementation that is used.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent.adoc
deleted file mode 100644
index 376bc25..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectPersistingEvent]]
-= `ObjectPersistingEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is about to be saved (inserted) into the database using the
-xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
-`#persist(...)` method.
-
-
-`ObjectPersistingEvent.Default` is the concrete implementation that is used.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent.adoc
deleted file mode 100644
index 0235513..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent.adoc
+++ /dev/null
@@ -1,20 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectRemovingEvent]]
-= `ObjectRemovingEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast
-when an object is about to be deleted from the database using the
-xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s
-`#remove(...)` method.
-
-
-`ObjectRemovingEvent.Default` is the concrete implementation that is used.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent.adoc
deleted file mode 100644
index 58695e5..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectUpdatedEvent]]
-= `ObjectUpdatedEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-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.adoc#_rgsvc-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.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent.adoc
deleted file mode 100644
index e78c649..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent.adoc
+++ /dev/null
@@ -1,22 +0,0 @@
-[[_rgcms_classes_lifecycleevent_manpage-ObjectUpdatingEvent]]
-= `ObjectUpdatingEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-
-Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_manpage-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.adoc#_rgsvc-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.
-
-[NOTE]
-====
-In the future this may be generalized to allow arbitrary subclasses to be broadcast, see ISIS-803.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc
index 6277ec5..7a7bfcf 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc
@@ -9,10 +9,10 @@ The interfaces listed in this chapter are role interfaces; they define a contrac
to interact with those domain objects that implement these interfaces.
-include::_rgcms_classes_roles_manpage-HoldsUpdatedAt.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_manpage-HoldsUpdatedBy.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_manpage-Timestampable.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_manpage-Dto.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_manpage-Persistable.adoc[leveloffset=+1]
+include::_rgcms_classes_roles_HoldsUpdatedAt.adoc[leveloffset=+1]
+include::_rgcms_classes_roles_HoldsUpdatedBy.adoc[leveloffset=+1]
+include::_rgcms_classes_roles_Timestampable.adoc[leveloffset=+1]
+include::_rgcms_classes_roles_Dto.adoc[leveloffset=+1]
+include::_rgcms_classes_roles_Persistable.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Dto.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Dto.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Dto.adoc
new file mode 100644
index 0000000..15b4293
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Dto.adoc
@@ -0,0 +1,61 @@
+[[_rgcms_classes_mixins_Dto]]
+= `Dto` (`1.11.0-SNAPSHOT`)
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+The `Dto` role interface (`1.11.0-SNAPSHOT`) is intended to be implemented by JAXB-annotated view models, that is, annotated using
+xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]. It enables the ability to download the XML and
+XSD schema of those objects using two xref:ugbtb.adoc#_ugbtb_more-advanced_decoupling_mixins[mixins],
+`Dto_downloadXml` and `Dto_downloadXsd`.
+
+The interface is just a marker interface (with no members), and is defined as:
+
+[source,java]
+----
+public interface Dto { }
+----
+
+The `Dto_downloadXml` mixin defines the following action:
+
+[source,java]
+----
+@Mixin
+public class Dto_downloadXml {
+ public Dto_downloadXml(final Dto dto) { ... } // <1>
+ public Object downloadXml(final String fileName) { ... } // <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.
+
+This will return the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`].
+
+The `Dto_downloadXsd` mixin is similar:
+
+[source,java]
+----
+@Mixin
+public class Dto_downloadXsd {
+ public Dto_downloadXsd(final Dto dto) { ... } // <1>
+ public Object downloadXsd(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.
+
+If the domain object's JAXB annotations reference only a single XSD schema then this will return that XML text as
+a xref: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.adoc#_rgcms_classes_value-types_Blob[`Blob`]. The `IsisSchemas` parameter to the action can be used to
+optionally ignore the common xref: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.adoc#_rgsvc-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/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedAt.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedAt.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedAt.adoc
new file mode 100644
index 0000000..0509d0f
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedAt.adoc
@@ -0,0 +1,44 @@
+[[_rgcms_classes_roles_HoldsUpdatedAt]]
+= `HoldsUpdatedAt`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_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 interface is defined as:
+
+[source,java]
+----
+public interface HoldsUpdatedAt {
+ void setUpdatedAt(java.sql.Timestamp updatedAt);
+}
+----
+
+The current time is obtained from the xref:rgsvc.adoc#_rgsvc-api_ClockService[`ClockService`].
+
+Entities that implement this interface often also implement xref:rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] role interface; as a convenience the xref:rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] interface combines the two roles.
+
+
+
+== 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`.
+
+For example:
+
+[source,java]
+----
+@javax.jdo.annotations.Version(
+ strategy=VersionStrategy.DATE_TIME,
+ column="version")
+public class Customer {
+ ...
+ public java.sql.Timestamp getVersionSequence() {
+ return (java.sql.Timestamp) JDOHelper.getVersion(this);
+ }
+}
+----
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedBy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedBy.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedBy.adoc
new file mode 100644
index 0000000..8c28df1
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedBy.adoc
@@ -0,0 +1,19 @@
+[[_rgcms_classes_roles_HoldsUpdatedBy]]
+= `HoldsUpdatedBy`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+The `HoldsUpdatedBy` role interface ...
+
+[source,java]
+----
+public interface HoldsUpdatedBy {
+ void setUpdatedBy(String updatedBy);
+}
+----
+
+Entities that implement this interface often also implement xref:rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] role interface; as a convenience the xref:rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] interface combines the two roles.
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Persistable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Persistable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Persistable.adoc
new file mode 100644
index 0000000..eaaccc1
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Persistable.adoc
@@ -0,0 +1,34 @@
+[[_rgcms_classes_mixins_Persistable]]
+= `Persistable` (`1.11.0-SNAPSHOT`)
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+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 for this role interface.
+
+Nevertheless, the `Persistable_downloadJdoMetadata` mixin (`1.11.0-SNAPSHOT`) provides the ability to download the
+JDO link:http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html[class metadata in XML] form. The mixin
+defines the following action:
+
+[source,java]
+----
+@Mixin
+public class Persistable_downloadJdoMetadata {
+ public Persistable_downloadJdoMetadata(final Persistable persistable) { ... } // <1>
+ public Object downloadJdoMetadata(final String fileName) { ... } // <2>
+ ...
+}
+----
+<1> provided as an action to any domain entity
+<2> actually this is '$$' in the code, a "special case" that means to use the derive the action name from the class name.
+
+This will return the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`].
+
+
+== Related Services
+
+The mixin delegates to the xref:rgsvc.adoc#_rgsvc-api_IsisJdoSupport[`IsisJdoSupport`] service to obtain
+a reference to the JDO `PersistenceManagerFactory`.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Timestampable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Timestampable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Timestampable.adoc
new file mode 100644
index 0000000..27e799f
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Timestampable.adoc
@@ -0,0 +1,23 @@
+[[_rgcms_classes_roles_Timestampable]]
+= `Timestampable`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+The `Timestampable` role interface is a convenience that combines the xref:rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces. It is defined as:
+
+[source,java]
+----
+public interface Timestampable
+ extends HoldsUpdatedAt, HoldsUpdatedBy {
+}
+----
+
+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.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Dto.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Dto.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Dto.adoc
deleted file mode 100644
index b7e4790..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Dto.adoc
+++ /dev/null
@@ -1,61 +0,0 @@
-[[_rgcms_classes_mixins_Dto]]
-= `Dto` (`1.11.0-SNAPSHOT`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `Dto` role interface (`1.11.0-SNAPSHOT`) is intended to be implemented by JAXB-annotated view models, that is, annotated using
-xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]. It enables the ability to download the XML and
-XSD schema of those objects using two xref:ugbtb.adoc#_ugbtb_more-advanced_decoupling_mixins[mixins],
-`Dto_downloadXml` and `Dto_downloadXsd`.
-
-The interface is just a marker interface (with no members), and is defined as:
-
-[source,java]
-----
-public interface Dto { }
-----
-
-The `Dto_downloadXml` mixin defines the following action:
-
-[source,java]
-----
-@Mixin
-public class Dto_downloadXml {
- public Dto_downloadXml(final Dto dto) { ... } // <1>
- public Object downloadXml(final String fileName) { ... } // <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.
-
-This will return the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_manpage-Clob[`Clob`].
-
-The `Dto_downloadXsd` mixin is similar:
-
-[source,java]
-----
-@Mixin
-public class Dto_downloadXsd {
- public Dto_downloadXsd(final Dto dto) { ... } // <1>
- public Object downloadXsd(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.
-
-If the domain object's JAXB annotations reference only a single XSD schema then this will return that XML text as
-a xref:rgcms.adoc#_rgcms_classes_value-types_manpage-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.adoc#_rgcms_classes_value-types_manpage-Blob[`Blob`]. The `IsisSchemas` parameter to the action can be used to
-optionally ignore the common xref: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.adoc#_rgsvc-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/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedAt.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedAt.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedAt.adoc
deleted file mode 100644
index d286c5d..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedAt.adoc
+++ /dev/null
@@ -1,44 +0,0 @@
-[[_rgcms_classes_roles_manpage-HoldsUpdatedAt]]
-= `HoldsUpdatedAt`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_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 interface is defined as:
-
-[source,java]
-----
-public interface HoldsUpdatedAt {
- void setUpdatedAt(java.sql.Timestamp updatedAt);
-}
-----
-
-The current time is obtained from the xref:rgsvc.adoc#_rgsvc-api_ClockService[`ClockService`].
-
-Entities that implement this interface often also implement xref:rgcms.adoc#_rgcms_classes_roles_manpage-HoldsUpdatedBy[`HoldsUpdatedBy`] role interface; as a convenience the xref:rgcms.adoc#_rgcms_classes_roles_manpage-Timestampable[`Timestampable`] interface combines the two roles.
-
-
-
-== 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`.
-
-For example:
-
-[source,java]
-----
-@javax.jdo.annotations.Version(
- strategy=VersionStrategy.DATE_TIME,
- column="version")
-public class Customer {
- ...
- public java.sql.Timestamp getVersionSequence() {
- return (java.sql.Timestamp) JDOHelper.getVersion(this);
- }
-}
-----
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedBy.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedBy.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedBy.adoc
deleted file mode 100644
index 9552043..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-HoldsUpdatedBy.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-[[_rgcms_classes_roles_manpage-HoldsUpdatedBy]]
-= `HoldsUpdatedBy`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `HoldsUpdatedBy` role interface ...
-
-[source,java]
-----
-public interface HoldsUpdatedBy {
- void setUpdatedBy(String updatedBy);
-}
-----
-
-Entities that implement this interface often also implement xref:rgcms.adoc#_rgcms_classes_roles_manpage-HoldsUpdatedAt[`HoldsUpdatedAt`] role interface; as a convenience the xref:rgcms.adoc#_rgcms_classes_roles_manpage-Timestampable[`Timestampable`] interface combines the two roles.
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Persistable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Persistable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Persistable.adoc
deleted file mode 100644
index 757cade..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Persistable.adoc
+++ /dev/null
@@ -1,34 +0,0 @@
-[[_rgcms_classes_mixins_Persistable]]
-= `Persistable` (`1.11.0-SNAPSHOT`)
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-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 for this role interface.
-
-Nevertheless, the `Persistable_downloadJdoMetadata` mixin (`1.11.0-SNAPSHOT`) provides the ability to download the
-JDO link:http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html[class metadata in XML] form. The mixin
-defines the following action:
-
-[source,java]
-----
-@Mixin
-public class Persistable_downloadJdoMetadata {
- public Persistable_downloadJdoMetadata(final Persistable persistable) { ... } // <1>
- public Object downloadJdoMetadata(final String fileName) { ... } // <2>
- ...
-}
-----
-<1> provided as an action to any domain entity
-<2> actually this is '$$' in the code, a "special case" that means to use the derive the action name from the class name.
-
-This will return the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_manpage-Clob[`Clob`].
-
-
-== Related Services
-
-The mixin delegates to the xref:rgsvc.adoc#_rgsvc-api_IsisJdoSupport[`IsisJdoSupport`] service to obtain
-a reference to the JDO `PersistenceManagerFactory`.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Timestampable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Timestampable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Timestampable.adoc
deleted file mode 100644
index a69d213..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_manpage-Timestampable.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-[[_rgcms_classes_roles_manpage-Timestampable]]
-= `Timestampable`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-
-
-The `Timestampable` role interface is a convenience that combines the xref:rgcms.adoc#_rgcms_classes_roles_manpage-HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:rgcms.adoc#_rgcms_classes_roles_manpage-HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces. It is defined as:
-
-[source,java]
-----
-public interface Timestampable
- extends HoldsUpdatedAt, HoldsUpdatedBy {
-}
-----
-
-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.adoc#_rgcms_classes_roles_manpage-HoldsUpdatedBy[`HoldsUpdatedBy`] for further details.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc
index 01b5745..ac2da73 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc
@@ -52,7 +52,7 @@ 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.adoc#_rgcms_classes_i18n_manpage-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.adoc#_rgcms_classes_i18n_TranslatableString[translatable string]:
[source,java]
----
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc
index 71ea4a4..82be5d0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc
@@ -19,7 +19,7 @@ Impl'n (g: a:)
|Notes
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractContainedObject[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`o.a.i.applib.` +
`AbstractContainedObject`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -27,7 +27,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractDomainObject[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractDomainObject[`o.a.i.applib.` +
`AbstractDomainObject`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -35,7 +35,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractFactoryAndRepository[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractFactoryAndRepository[`o.a.i.applib.` +
`AbstractFactoryAndRepository`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -43,7 +43,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractService[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractService[`o.a.i.applib.` +
`AbstractService`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -51,7 +51,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractSubscriber[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`o.a.i.applib.` +
`AbstractSubscriber`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -59,7 +59,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-AbstractViewModel[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractViewModel[`o.a.i.applib.` +
`AbstractViewModel`]
|``o.a.i.core`` +
``isis-core-applib``
@@ -67,7 +67,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-FixtureScript[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`o.a.i.applib.` +
`fixturescript` +
`FixtureScript`]
|``o.a.i.core`` +
@@ -76,7 +76,7 @@ Impl'n (g: a:)
|
-|xref:rgcms.adoc#_rgcms_classes_super_manpage-FixtureScripts[`o.a.i.applib.` +
+|xref:rgcms.adoc#_rgcms_classes_super_FixtureScripts[`o.a.i.applib.` +
`fixturescripts` +
`FixtureScripts`]
|``o.a.i.core`` +
@@ -93,13 +93,13 @@ Impl'n (g: a:)
-include::_rgcms_classes_super_manpage-AbstractContainedObject.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-AbstractDomainObject.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-AbstractFactoryAndRepository.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-AbstractService.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-AbstractSubscriber.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-AbstractViewModel.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-FixtureScript.adoc[leveloffset=+1]
-include::_rgcms_classes_super_manpage-FixtureScripts.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractContainedObject.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractDomainObject.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractFactoryAndRepository.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractService.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractSubscriber.adoc[leveloffset=+1]
+include::_rgcms_classes_super_AbstractViewModel.adoc[leveloffset=+1]
+include::_rgcms_classes_super_FixtureScript.adoc[leveloffset=+1]
+include::_rgcms_classes_super_FixtureScripts.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractContainedObject.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractContainedObject.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractContainedObject.adoc
new file mode 100644
index 0000000..806ed81
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractContainedObject.adoc
@@ -0,0 +1,32 @@
+[[_rgcms_classes_super_AbstractContainedObject]]
+= `AbstractContainedObject`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+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.
+
+* `newTransientInstance(Class)` - to create a new instance of an object, with any services injected into it
+
+* `persistIfNotAlready(Object)` - to persist an object +
++
+In fact, the object is queued up to be persisted, and is only actually persisted either when the transaction commits, or
+when the transaction is flushed (typically when a query is performed).
+
+* `warnUser(String)` - generate a warning to the user
+
+* `getContainer()` - which returns the `DomainObjectContainer`
+
+Each of these methods simply delegates to an equivalent method in xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer[`DomainObjectContainer`].
+
+[TIP]
+====
+In practice we find that there's little to gain from subclassing; it's easier/less obscure to simply inject xref:rgsvc.adoc#_rgsvc-api_DomainObjectContainer[`DomainObjectContainer`] into a simple pojo class.
+====
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractDomainObject.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractDomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractDomainObject.adoc
new file mode 100644
index 0000000..a9dec97
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractDomainObject.adoc
@@ -0,0 +1,14 @@
+[[_rgcms_classes_super_AbstractDomainObject]]
+= `AbstractDomainObject`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+This class extends xref: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.adoc#_rgsvc-api_DomainObjectContainer[`DomainObjectContainer`].
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractFactoryAndRepository.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
new file mode 100644
index 0000000..8e662b4
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
@@ -0,0 +1,15 @@
+[[_rgcms_classes_super_AbstractFactoryAndRepository]]
+= `AbstractFactoryAndRepository`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+This class extends xref: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.adoc#_rgant-DomainService_repositoryFor[`@DomainService#repositoryFor()`] attribute.
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractService.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractService.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractService.adoc
new file mode 100644
index 0000000..d4b01a6
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractService.adoc
@@ -0,0 +1,10 @@
+[[_rgcms_classes_super_AbstractService]]
+= `AbstractService`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+This class extends xref: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.adoc#_rgsvc-api_DomainObjectContainer[`DomainObjectContainer`] for broadly equivalent functionality.
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractSubscriber.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractSubscriber.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractSubscriber.adoc
new file mode 100644
index 0000000..f5aa7b7
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractSubscriber.adoc
@@ -0,0 +1,18 @@
+[[_rgcms_classes_super_AbstractSubscriber]]
+= `AbstractSubscriber`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+This is a convenience superclass for creating subscriber domain services on the xref:rgsvc.adoc#_rgsvc-api_EventBusService[`EventBusService`]. It uses xref:rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] and
+xref: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.adoc#_rgsvc-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.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.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute.
+
+As a convenience, (as of `1.11.0-SNAPSHOT`) the `AbstractSubscriber` specifies this attribute.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/43fc7bc1/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractViewModel.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractViewModel.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractViewModel.adoc
new file mode 100644
index 0000000..1f6bb81
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractViewModel.adoc
@@ -0,0 +1,15 @@
+[[_rgcms_classes_super_AbstractViewModel]]
+= `AbstractViewModel`
+:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+
+
+This class extends xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], also
+implementing the xref:rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface. In and of itself it provides no new behaviour.
+
+[TIP]
+====
+As an alternative, consider simply annotating the view model class with {@link org.apache.isis.applib.annotation.ViewModel}.
+====
+