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/03/31 07:11:11 UTC
[35/51] [partial] isis git commit: ISIS-1521: reorganizes asciidoc
documentation, moves into subdirs (both guides and other pages)
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_mixins_Persistable.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_mixins_Persistable.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_mixins_Persistable.adoc
deleted file mode 100644
index f68548a..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_mixins_Persistable.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-[[_rgcms_classes_mixins_Persistable]]
-= `Persistable`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 to obtain the mixins that contribute to this interface.
-
-[[__rgcms_classes_mixins_Persistable_downloadJdoMetadata]]
-== `downloadJdoMetadata()`
-
-The `Persistable_downloadJdoMetadata` mixin provides an action which allows the
-JDO link:http://www.datanucleus.org/products/datanucleus/jdo/metadata_xml.html[class metadata] to be downloaded as XML. It has the following signature:
-
-[source,java]
-----
-public Clob downloadJdoMetadata( // <1>
- @ParameterLayout(named = ".jdo file name")
- final String fileName) {
- ...
-}
-----
-<1> returns the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`].
-
-
-=== Appearance in the UI
-
-This mixin action is associated with the "Metadata" fieldset, and will appear as a panel drop-down action.
-
-These mixin properties are all associated with the "Metadata" fieldset. The xref:rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
-
-=== Related Services
-
-The mixin delegates to the xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service to obtain
-a reference to the JDO `PersistenceManagerFactory`.
-
-
-[[__rgcms_classes_mixins_Persistable_datanucleusXxx]]
-== `datanucleusXxx`
-
-The framework provides a number of mixins that expose the datanucleus Id and version of a persistable domain entity. Several implementations are provided to support different datatypes:
-
-* `Persistable_datanucleusIdLong` will expose the entity's id, assuming that the id is or can be cast to `java.lang.Long`. Otherwise the property will be hidden.
-
-* `Persistable_datanucleusVersionTimestamp` will expose the entity's version, assuming that the version is or can be cast to `java.sql.Timestamp`. Otherwise the property will be hidden.
-
-* `Persistable_datanucleusVersionLong` will expose the entity's version, assuming that the version is or can be cast to `java.lang.Long`. Otherwise the property will be hidden.
-
-=== Appearance in the UI
-
-These mixin properties are all associated with the "Metadata" fieldset. The xref:rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset.
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/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
deleted file mode 100644
index e100f47..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles.adoc
+++ /dev/null
@@ -1,16 +0,0 @@
-[[_rgcms_classes_roles]]
-= Roles
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 interfaces listed in this chapter are role interfaces; they define a contract for the framework
- to interact with those domain objects that implement these interfaces.
-
-
-include::_rgcms_classes_roles_HoldsUpdatedAt.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_HoldsUpdatedBy.adoc[leveloffset=+1]
-include::_rgcms_classes_roles_Timestampable.adoc[leveloffset=+1]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/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
deleted file mode 100644
index 50631ba..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedAt.adoc
+++ /dev/null
@@ -1,44 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index 8c28df1..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_HoldsUpdatedBy.adoc
+++ /dev/null
@@ -1,19 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index 27e799f..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_roles_Timestampable.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index ac2da73..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_spec.adoc
+++ /dev/null
@@ -1,108 +0,0 @@
-[[_rgcms_classes_spec]]
-= Specification pattern
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 interfaces and classes listed in this chapter provide support for the `Specification` pattern, as described in Eric Evans' book _Domain Driven Design_, p224.
-
-Apache Isis will automatically apply such specifications as validation rules on properties (as per xref:rgant.adoc#_rgant-Property_mustSatisfy[`@Property#mustSatisfy()`]) and on action parameters (as per xref:rgant.adoc#_rgant-Parameter_mustSatisfy[`@Parameter#mustSatisfy()`]).
-
-
-
-[_rgcms_classes_spec-Specification]
-== `Specification`
-
-The heart of the support for this pattern is the `Specification` interface:
-
-[source,java]
-----
-public interface Specification {
- public String satisfies(Object obj); // <1>
-}
-----
-<1> if returns `null`, then the constraint is satisfies; otherwise returns the reason why the constraint has not been satisfied.
-
-
-For example:
-
-[source,java]
-----
-public class StartWithCapitalLetterSpecification implements Specification {
- public String satisfies(Object proposedObj) {
- String proposed = (String)proposedObj; // <1>
- return "".equals(proposed)
- ? "Empty string"
- : !Character.isUpperCase(proposed.charAt(0))
- ? "Does not start with a capital letter"
- : null;
- }
-}
-public class Customer {
- @Property(mustSatisfy=StartWithCapitalLetterSpecification.class)
- public String getFirstName() { ... }
- ...
-}
-----
-<1> this ugly cast can be avoided using some of the other classes available; see below.
-
-
-
-[_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_TranslatableString[translatable string]:
-
-[source,java]
-----
-public interface Specification2 extends Specification {
- public TranslatableString satisfiesTranslatable(Object obj); // <1>
-}
-----
-<1> if returns `null`, then the constraint is satisfies; otherwise returns the reason why the constraint has not been satisfied.
-
-
-Note that if implementing `Specification2` then there is no need to also provide an implementation of the inherited `satisfies(Object)` method; this will never be called by the framework for `Specification2` instances.
-
-
-
-
-[_rgcms_classes_spec-adapter_classes]
-== Adapter classes
-
-The `AbstractSpecification` and `AbstractSpecification2` adapter classes provide a partial implementation of the respective interfaces, providing type-safety. (Their design is modelled on the `TypesafeMatcher` class within link:http://hamcrest.org/JavaHamcrest/[Hamcrest]).
-
-For example:
-
-[source,java]
-----
-public class StartWithCapitalLetterSpecification extends AbstractSpecification<String> {
- public String satisfiesSafely(String proposed) {
- return "".equals(proposed)
- ? "Empty string"
- : !Character.isUpperCase(proposed.charAt(0))
- ? "Does not start with a capital letter"
- : null;
- }
-}
-public class Customer {
- @Property(mustSatisfy=StartWithCapitalLetterSpecification.class)
- public String getFirstName() { ... }
- ...
-}
-----
-
-The `AbstractSpecification2` class is almost identical; its type-safe method is `satisfiesTranslatableSafely(T)` instead.
-
-
-[_rgcms_classes_spec-combining_specifications]
-== Combining specifications
-
-There are also adapter classes that can be inherited from to combine specifications:
-
-* `SpecificationAnd` - all provided specifications' constraints must be met
-* `SpecificationOr` - at least one provided specifications' constraints must be met
-* `SpecificationNot` - its constraints are met if-and-only-if the provided specification's constraint was _not_ met.
-
-Note that these adapter classes inherit `Specification` but do not inherit `Specification2`; in other words they do not support i18n.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/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
deleted file mode 100644
index 1332867..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super.adoc
+++ /dev/null
@@ -1,105 +0,0 @@
-[[_rgcms_classes_super]]
-= Superclasses
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 section catalogues the various convenience (non event) superclasses defined by Apache Isis. These are listed in the table below.
-
-
-.Convenience Superclasses
-[cols="2,4a,1,1", options="header"]
-|===
-
-|API
-|Maven Module +
-Impl'n (g: a:)
-|Implementation
-|Notes
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`o.a.i.applib.` +
-`AbstractContainedObject`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractDomainObject[`o.a.i.applib.` +
-`AbstractDomainObject`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractFactoryAndRepository[`o.a.i.applib.` +
-`AbstractFactoryAndRepository`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractService[`o.a.i.applib.` +
-`AbstractService`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractSubscriber[`o.a.i.applib.` +
-`AbstractSubscriber`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_AbstractViewModel[`o.a.i.applib.` +
-`AbstractViewModel`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`o.a.i.applib.` +
-`fixturescript` +
-`FixtureScript`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class)
-|
-
-
-|xref:rgcms.adoc#_rgcms_classes_super_FixtureScripts[`o.a.i.applib.` +
-`fixturescripts` +
-`FixtureScripts`]
-|``o.a.i.core`` +
-``isis-core-applib``
-|(abstract class). +
-`FixtureScriptsDefault` is a default implementation that is used when the alternative xref:rgsvc.adoc#_rgsvc_api_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] is provided
- (and no other implementation of `FixtureScripts` was found).
-|depends on: +
-`ClassDiscoveryService`
-
-
-|===
-
-
-
-
-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/2669a971/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
deleted file mode 100644
index da9d9d8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractContainedObject.adoc
+++ /dev/null
@@ -1,32 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index 8d5837b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractDomainObject.adoc
+++ /dev/null
@@ -1,14 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index 8e662b4..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractFactoryAndRepository.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index d928d29..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractService.adoc
+++ /dev/null
@@ -1,10 +0,0 @@
-[[_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/2669a971/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
deleted file mode 100644
index 9e36dce..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractSubscriber.adoc
+++ /dev/null
@@ -1,18 +0,0 @@
-[[_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, the `AbstractSubscriber` specifies this attribute.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/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
deleted file mode 100644
index 1f6bb81..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_AbstractViewModel.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
-[[_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}.
-====
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScript.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScript.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScript.adoc
deleted file mode 100644
index ca653ec..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScript.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
-[[_rgcms_classes_super_FixtureScript]]
-= `FixtureScript`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 `FixtureScript` class is an abstract class defining an API to set up data within the object store, either for integration tests or while demoing/prototyping.
-
-The primary method that subclasses must implement is:
-
-[source,java]
-----
-protected abstract void execute(final ExecutionContext executionContext);
-----
-
-In this method the fixture script can in theory do anything, but in practice it is recommended that it uses injected
-domain services to set up data. The provided `ExecutionContext` is used to invoke child fixture scripts, and alsocan be used to store references to any created objects (so that the calling test can access these objects/so that they are rendered in the view model).
-
-See the see the xref:ugtst.adoc#_ugtst_fixture-scripts[user guide's testing chapter] for further discussion on the use of fixture scripts, in particular xref:ugtst.adoc#_ugtst_fixture-scripts_api-and-usage[fixture scripts' API and usage].
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScripts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScripts.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScripts.adoc
deleted file mode 100644
index 51e143b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_super_FixtureScripts.adoc
+++ /dev/null
@@ -1,12 +0,0 @@
-[[_rgcms_classes_super_FixtureScripts]]
-= `FixtureScripts`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 abstract class is intended to allow a domain service that can execute xref:rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`]s to be easily written.
-
-However, it has now been deprecated; instead we recommend that the xref:rgsvc.adoc#_rgsvc_spi_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] service is
-implemented instead. The framework will then automatically use xref:rgsvc.adoc#_rgsvc_api_FixtureScriptsDefault[`FixtureScriptsDefault`] as a fallback implementation of this class.
-
-See the see the xref:ugtst.adoc#_ugtst_fixture-scripts[user guide's testing chapter] for further discussion on the use of fixture scripts, in particular xref:ugtst.adoc#_ugtst_fixture-scripts_api-and-usage[fixture scripts' API and usage].
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent.adoc
deleted file mode 100644
index ba0e3f8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent.adoc
+++ /dev/null
@@ -1,62 +0,0 @@
-[[_rgcms_classes_uievent]]
-= UI Event Classes
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 section catalogues the various UI event classes defined by Apache Isis.
-
-These events are broadcast on the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. The domain
-events are broadcast as a result of being specified in the xref:rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`], xref:rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`@DomainObjectLayout#iconUiEvent()`] or xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`@DomainObjectLayout#cssClassUiEvent()`] attributes.
-
-They are listed in the table below.
-
-.UI Event Classes
-[cols="2,4a,1,1", options="header"]
-|===
-
-|API
-|Maven Module +
-Impl'n (g: a:)
-|Implementation
-|Notes
-
-
-|xref:rgcms.adoc#_rgcms_classes_uievent_TitleUiEvent[`o.a.i.applib.` +
-`TitleUiEvent`]
-|``o.a.i.core`` +
-``services.eventbus`` +
-``isis-core-applib``
-|(abstract class). +
-`TitleUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#titleUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain a title for a domain object. Note that if the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] supporting method, or has xref:rgant.adoc#_rgant-Title[`@Title`] annotation(s) on its properties, then these will take precedence.
-
-|xref:rgcms.adoc#_rgcms_classes_uievent_IconUiEvent[`o.a.i.applib.` +
-`IconUiEvent`]
-|``o.a.i.core`` +
-``services.eventbus`` +
-``isis-core-applib``
-|(abstract class). +
-`IconUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#iconUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain an icon (or rather, the name of an icon) for a domain object. Note that if the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] supporting method, or if it has the xref:rgant.adoc#_rgant-DomainObjectLayout#cssClassFa[`@DomainObjectLayout#cssClassFa()`] attribute, then these will take precedence.
-
-|xref:rgcms.adoc#_rgcms_classes_uievent_CssClassUiEvent[`o.a.i.applib.` +
-`CssClassUiEvent`]
-|``o.a.i.core`` +
-``services.eventbus`` +
-``isis-core-applib``
-|(abstract class). +
-`CssClassUiEvent.Default` is the concrete implementation used if no `@DomainObjectLayout#cssClassUiEvent` attribute is specified
-|Broadcast whenever there is a requirement to obtain a CSS class hint for a domain object. Note that if the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] supporting method then this
-will take precedence.
-
-|===
-
-
-
-
-include::_rgcms_classes_uievent_TitleUiEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_uievent_IconUiEvent.adoc[leveloffset=+1]
-include::_rgcms_classes_uievent_CssClassUiEvent.adoc[leveloffset=+1]
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_CssClassUiEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_CssClassUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_CssClassUiEvent.adoc
deleted file mode 100644
index 5190d6e..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_CssClassUiEvent.adoc
+++ /dev/null
@@ -1,22 +0,0 @@
-[[_rgcms_classes_uievent_CssClassUiEvent]]
-= `CssClassUiEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 event class represents a request to obtain the a CSS class hint of a domain object. The class has a number of
-responsibilities:
-
-* capture the target object being interacted with
-
-* capture the CSS class, if any, as specified to one of the subscribers
-
-The class itself is instantiated automatically by the framework whenever interacting with a rendered object's action.
-
-
-[NOTE]
-====
-if the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] supporting
-method then this will take precedence.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_IconUiEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_IconUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_IconUiEvent.adoc
deleted file mode 100644
index c94b5c8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_IconUiEvent.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-[[_rgcms_classes_uievent_IconUiEvent]]
-= `IconUiEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 event class represents a request to obtain the icon (or rather, name of icon) of a domain object. The class has a number of responsibilities:
-
-* capture the target object being interacted with
-
-* capture the icon (name), if any, as specified to one of the subscribers
-
-The class itself is instantiated automatically by the framework whenever interacting with a rendered object's action.
-
-
-[NOTE]
-====
-If the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] supporting method,
-or if it has the
-xref:rgant.adoc#_rgant-DomainObjectLayout#cssClassFa[`@DomainObjectLayout#cssClassFa()`] attribute, then
-these will take precedence.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_TitleUiEvent.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_TitleUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_TitleUiEvent.adoc
deleted file mode 100644
index d4164e7..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_uievent_TitleUiEvent.adoc
+++ /dev/null
@@ -1,22 +0,0 @@
-[[_rgcms_classes_uievent_TitleUiEvent]]
-= `TitleUiEvent`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 event class represents a request to obtain the title of a domain object. The class has a number of responsibilities:
-
-* capture the target object being interacted with
-
-* capture the title, if any, as specified to one of the subscribers
-
-The class itself is instantiated automatically by the framework whenever interacting with a rendered object's action.
-
-
-[NOTE]
-====
-If the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] supporting method, or
-has xref:rgant.adoc#_rgant-Title[`@Title`] annotation(s) on its properties, then these will take
-precedence.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility.adoc
deleted file mode 100644
index 440409b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility.adoc
+++ /dev/null
@@ -1,16 +0,0 @@
-[[_rgcms_classes_utility]]
-= Applib Utility Classes
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 `org.apache.isis.applib.util` package has a number of simple utility
-classes designed to simplify the coding of some common tasks.
-
-
-include::_rgcms_classes_utility_Enums.adoc[leveloffset=+1]
-include::_rgcms_classes_utility_ObjectContracts.adoc[leveloffset=+1]
-include::_rgcms_classes_utility_Reasons.adoc[leveloffset=+1]
-include::_rgcms_classes_utility_TitleBuffer.adoc[leveloffset=+1]
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
deleted file mode 100644
index 3f43c6b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Enums.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
-[[_rgcms_classes_utility_Enums]]
-= `Enums`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-NOTE: TODO
-
-[source,java]
-----
-public final class Enums {
- public static String getFriendlyNameOf(Enum<?> anEnum) { ... }
- public static String getFriendlyNameOf(String anEnumName) { ... }
- public static String getEnumNameFromFriendly(String anEnumFriendlyName) { ... }
- public static String enumToHttpHeader(final Enum<?> anEnum) { ... }
- public static String enumNameToHttpHeader(final String name) { ... }
- public static String enumToCamelCase(final Enum<?> anEnum) { ... }
-}
-----
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_ObjectContracts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_ObjectContracts.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_ObjectContracts.adoc
deleted file mode 100644
index beac5e2..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_ObjectContracts.adoc
+++ /dev/null
@@ -1,107 +0,0 @@
-[[_rgcms_classes_utility_ObjectContracts]]
-= `ObjectContracts`
-: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 `ObjectContracts` test provides a series of methods to make it easy for your domain objects to:
-
-* implement `Comparable` (eg so can be stored in ``java.util.SortedSet``s)
-* implement `toString()`
-* implement `equals()`
-* implement `hashCode()`
-
-For example:
-
-[source,java]
-----
-public class ToDoItem implements Comparable<ToDoItem> {
-
- public boolean isComplete() { ... }
- public LocalDate getDueBy() { ... }
- public String getDescription() { ... }
- public String getOwnedBy() { ... }
-
- public int compareTo(final ToDoItem other) {
- return ObjectContracts.compare(this, other, "complete","dueBy","description");
- }
-
- public String toString() {
- return ObjectContracts.toString(this, "description","complete","dueBy","ownedBy");
- }
-}
-----
-
-[WARNING]
-====
-Note that `ObjectContracts` makes heavy use of Java Reflection. While it's great to get going quickly in prototyping, we recommend you use your IDE to code generate implementations of these methods for production code.
-
-Moreover (and perhaps even more importantly) `ObjectContracts` implementation can cause DataNucleus to recursively rehydrate a larger number of associated entities (More detail below).
-
-We therefore recommend that you disable persistence-by-reachability by adding:
-
-[source,ini]
-.persistor_datanucleus.properties
-----
-isis.persistor.datanucleus.impl.datanucleus.persistenceByReachabilityAtCommit=false
-----
-
-====
-
-== The issue in more detail
-
-Consider the link:http://yuml.me/edit/742ad446[entities]:
-
-image::{_imagesdir}reference-classes/issue-in-more-detail.png[link="{_imagesdir}reference-classes/issue-in-more-detail.png"]
-
-In the course of a transaction, the `Agreement` entity is loaded into memory (not necessarily modified), and then new ``AgreementRole``s are associated to it.
-
-All these entities implement `Comparable` using `ObjectContracts`, so that the implementation of ``AgreementRole``'s (simplified) is:
-
-[source,java]
-----
-public class AgreementRole {
- ...
- public int compareTo(AgreementRole other) {
- return ObjectContracts.compareTo(this, other, "agreement","startDate","party");
- }
- ...
-}
-----
-
-while ``Agreement``'s is implemented as:
-
-[source,java]
-----
- public class Agreement {
- ...
- public int compareTo(Agreement other) {
- return ObjectContracts.compareTo(this, other, "reference");
- }
- ...
- }
-----
-
-and ``Party``'s is similarly implemented as:
-
-[source,java]
-----
-public class Party {
- ...
- public int compareTo(Party other) {
- return ObjectContracts.compareTo(this, other, "reference");
- }
- ...
-}
-----
-
-DataNucleus's persistence-by-reachability algorithm adds the ``AgreementRole``s into a `SortedSet`, which causes `AgreementRole#compareTo()` to fire:
-
-* the evaluation of the "agreement" property delegates back to the `Agreement`, whose own `Agreement#compareTo()` uses the scalar `reference` property. As the `Agreement` is already in-memory, this does not trigger any further database queries
-
-* the evaluation of the "startDate" property is just a scalar property of the `AgreementRole`, so will already in-memory
-
-* the evaluation of the "party" property delegates back to the `Party`, whose own `Party#compareTo()` requires the uses the scalar `reference` property. However, since the `Party` is not yet in-memory, using the `reference` property triggers a database query to "rehydrate" the `Party` instance.
-
-In other words, figuring out whether `AgreementRole` is comparable requires the persistence-by-reachability algorithm to run, causing the adjacent associated entity `Party` to also be retrieved.
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Reasons.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Reasons.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Reasons.adoc
deleted file mode 100644
index 71a7e0c..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_Reasons.adoc
+++ /dev/null
@@ -1,31 +0,0 @@
-[[_rgcms_classes_utility_Reasons]]
-= `Reasons`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-
-There are two different classes provided to help build reasons returned
-by `disableXxX()` and `validateXxx()` methods:
-
-* the `org.apache.isis.applib.util.ReasonBuffer` helper class
-* the `org.apache.isis.applib.util.Reasons` helper class
-
-For example:
-
-[source,java]
-----
-public class Customer {
- ...
- public String validatePlaceOrder(Product p, int quantity) {
- return Reasons.coalesce(
- whetherCustomerBlacklisted(this),
- whetherProductOutOfStock(p)
- );
- }
-}
-----
-
-Which you use (if any) is up to you.
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_TitleBuffer.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_TitleBuffer.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_TitleBuffer.adoc
deleted file mode 100644
index ec5ad0e..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_utility_TitleBuffer.adoc
+++ /dev/null
@@ -1,13 +0,0 @@
-[[_rgcms_classes_utility_TitleBuffer]]
-= `TitleBuffer`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 `TitleBuffer` utility class is intended to make it easy to construct title strings (returned from the xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] method).
-
-For example, it has overloaded versions of methods called `append()` and `concat()`.
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types.adoc
deleted file mode 100644
index f73650f..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types.adoc
+++ /dev/null
@@ -1,119 +0,0 @@
-[[_rgcms_classes_value-types]]
-= Value Types
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-NOTE: TODO
-
-
-
-.JDK Classes
-[cols="1,1", options="header"]
-|===
-
-|Type
-|Description
-
-|`java.lang.Boolean`
-|
-
-|`java.lang.Character`
-|
-
-|`java.lang.Double`
-|
-
-|`java.lang.Float`
-|
-
-|`java.lang.Integer`
-|
-
-|`java.lang.Long`
-|
-
-|`java.lang.Short`
-|
-
-|`java.lang.String`
-|
-
-|`java.math.BigDecimal`
-|
-
-|`java.math.BigInteger`
-|
-
-|`java.sql.Date`
-|
-
-|`java.sql.Time`
-|
-
-|`java.sql.Timestamp`
-|
-
-|`java.util.Date`
-|
-
-|===
-
-
-.JodaTime classes
-[cols="1,1", options="header"]
-|===
-
-|Type
-|Description
-
-|`org.joda.time.DateTime`
-|
-
-|`org.joda.time.LocalDateTime`
-|
-
-|`org.joda.time.LocalDate`
-|
-
-|===
-
-
-
-
-.Isis Applib classes
-[cols="1,1", options="header"]
-|===
-
-|Type
-|Description
-
-|`o.a.i.applib.value.` +
-`Blob`
-|
-
-|`o.a.i.applib.value.` +
-`Clob`
-|
-
-|`o.a.i.applib.value.` +
-`Color`
-|
-
-|`o.a.i.applib.value.` +
-`Money`
-|
-
-|`o.a.i.applib.value.` +
-`Password`
-|
-
-|===
-
-
-
-include::_rgcms_classes_value-types_Blob.adoc[leveloffset=+1]
-include::_rgcms_classes_value-types_Clob.adoc[leveloffset=+1]
-include::_rgcms_classes_value-types_Color.adoc[leveloffset=+1]
-include::_rgcms_classes_value-types_Money.adoc[leveloffset=+1]
-include::_rgcms_classes_value-types_Password.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Blob.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Blob.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Blob.adoc
deleted file mode 100644
index da506e1..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Blob.adoc
+++ /dev/null
@@ -1,50 +0,0 @@
-[[_rgcms_classes_value-types_Blob]]
-= `Blob`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-`Blob` (in the `org.apache.isis.applib.value` package) is a value type defined by the Apache Isis framework to
-represent a binary large object. Conceptually you can consider it as a set of bytes (a picture, a video etc), though
-in fact it wraps three pieces of information:
-
-- the set of bytes
-- a name
-- a mime type.
-
-This is reflected in the class' constructors and properties:
-
-[source,java]
-----
-public final class Blob ... {
- ...
- public Blob(String name, String primaryType, String subtype, byte[] bytes) { ... }
- public Blob(String name, String mimeTypeBase, byte[] bytes) { ... }
- public Blob(String name, MimeType mimeType, byte[] bytes) { ... }
- ...
- public String getName() { ... }
- public MimeType getMimeType() { ... }
- public byte[] getBytes() { ... }
- ...
-}
-----
-
-
-Properties of this type can be mapped to JDO/DataNucleus using:
-
-[source,java]
-----
-@javax.jdo.annotations.Persistent(defaultFetchGroup="false", columns = {
- @javax.jdo.annotations.Column(name = "someImage_name"),
- @javax.jdo.annotations.Column(name = "someImage_mimetype"),
- @javax.jdo.annotations.Column(name = "someImage_bytes", jdbcType = "BLOB", sqlType = "LONGVARBINARY")
-})
-private Blob someImage;
-----
-
-
-[TIP]
-====
-For character large objects, use xref:rgcms.adoc#_rgcms_classes_value-types_Clob][`Clob`] value type.
-====
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Clob.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Clob.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Clob.adoc
deleted file mode 100644
index 155509a..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Clob.adoc
+++ /dev/null
@@ -1,56 +0,0 @@
-[[_rgcms_classes_value-types_Clob]]
-= `Clob`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-`Clob` (in the `org.apache.isis.applib.value` package) is a value type defined by the Apache Isis framework to
-represent a character large object. Conceptually you can consider it as a set of characters (an RTF or XML document,
-for example), though in fact it wraps three pieces of information:
-
-- the set of characters
-- a name
-- a mime type.
-
-
-This is reflected in the class' constructors and properties:
-
-[source,java]
-----
-public final class Clob ... {
- ...
- public Clob(String name, String primaryType, String subType, char[] chars) { ... }
- public Clob(String name, String mimeTypeBase, char[] chars) { ... }
- public Clob(String name, MimeType mimeType, char[] chars) { ... }
- public Clob(String name, String primaryType, String subType, CharSequence chars) { ... }
- public Clob(String name, String mimeTypeBase, CharSequence chars) { ... }
- public Clob(String name, MimeType mimeType, CharSequence chars) { ... }
- ...
- public String getName() { ... }
- public MimeType getMimeType() { ... }
- public CharSequence getChars() { ... }
- ...
-}
-----
-
-
-Properties of this type can be mapped to JDO/DataNucleus using:
-
-[source,java]
-----
-@javax.jdo.annotations.Persistent(defaultFetchGroup="false", columns = {
- @javax.jdo.annotations.Column(name = "someClob_name"),
- @javax.jdo.annotations.Column(name = "someClob_mimetype"),
- @javax.jdo.annotations.Column(name = "someClob_chars", jdbcType = "CLOB", sqlType = "LONGVARCHAR")
-})
-private Clob someClob;
-----
-
-
-[TIP]
-====
-For binary large objects, use xref:rgcms.adoc#_rgcms_classes_value-types_Blob][`Blob`] value type.
-====
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Color.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Color.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Color.adoc
deleted file mode 100644
index e04cc6e..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Color.adoc
+++ /dev/null
@@ -1,8 +0,0 @@
-[[_rgcms_classes_value-types_Color]]
-= `Color`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-NOTE: TODO - the `org.apache.isis.applib.value.Color` class.
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Money.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Money.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Money.adoc
deleted file mode 100644
index 7f8bdf3..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Money.adoc
+++ /dev/null
@@ -1,8 +0,0 @@
-[[_rgcms_classes_value-types_Money]]
-= `Money`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-NOTE: TODO - the `org.apache.isis.applib.value.Money` class.
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Password.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Password.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Password.adoc
deleted file mode 100644
index f70ebc5..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_classes_value-types_Password.adoc
+++ /dev/null
@@ -1,8 +0,0 @@
-[[_rgcms_classes_value-types_Password]]
-= `Password`
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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/
-
-
-NOTE: TODO
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods.adoc
deleted file mode 100644
index dccbf0b..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-[[_rgcms_methods]]
-= Methods
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 Apache Isis metamodel is built up from declaratively (ie, xref:rgant.adoc#_rgant[annotations]) and imperatively, from "supporting" methods and other reserved methods.
-
-This chapter documents the supporting methods and the reserved methods. It also documents (separately) the reserved methods that act as callback hooks into the persistence lifecycle of domain entities.
-
-
-include::_rgcms_methods_prefixes.adoc[leveloffset=+1]
-include::_rgcms_methods_reserved.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle.adoc[leveloffset=+1]
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle.adoc
deleted file mode 100644
index c9bc5ac..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle.adoc
+++ /dev/null
@@ -1,102 +0,0 @@
-[[_rgcms_methods_lifecycle]]
-= Lifecycle Methods
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or 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 lifecycle callback methods notify a domain entity about its interaction within the persistence lifecycle. For example, the entity is notified immediately prior to being persisted, or when it is about to be updated.
-
-[WARNING]
-====
-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.
-
-* alternatively, you can use a subscriber for the xref:rgcms.adoc#_rgcms_classes_lifecycleevent[lifecycle event]s fired in Isis.
-====
-
-The lifecycle callback methods supported by Isis are:
-
-.Lifecycle methods (partial support)
-[cols="1,4a", options="header"]
-|===
-
-|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.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()`]
-|called when object has just been persisted from the object store.
-
-|xref: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()`]
-|called when a (persistent) object has just been deleted from the object store
-
-|xref: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()`]
-|called when a (persistent) object has just been updated in the object store
-
-|xref:rgcms.adoc#_rgcms_methods_lifecycle_updating[`updating()`]
-|called when a (persistent) object is just about to be updated in the object store
-
-|===
-
-
-
-Some lifecycle methods have been deprecated:
-
-.Deprecated lifecycle methods
-[cols="1,4a", options="header"]
-|===
-
-|Method
-|Notes
-
-|`deleted()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_removed[`removed()`]
-
-|`deleting()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_removing[`removing()`]
-
-|`loading()`
-|callback for when the (persistent) object is just about to be loaded from the object store. +
-
-[WARNING]
-====
-This method is never called.
-====
-
-|`saved()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_persisted[`persisted()`]
-
-|`saving()`
-|Replaced by xref:rgcms.adoc#_rgcms_methods_lifecycle_persisting[`persisting()`]
-
-|===
-
-
-
-
-include::_rgcms_methods_lifecycle_created.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_loaded.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_persisted.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_persisting.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_removed.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_removing.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_updated.adoc[leveloffset=+1]
-include::_rgcms_methods_lifecycle_updating.adoc[leveloffset=+1]
-
-include::_rgcms_methods_lifecycle_jdo-api.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_created.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_created.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_created.adoc
deleted file mode 100644
index 72956d4..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_created.adoc
+++ /dev/null
@@ -1,17 +0,0 @@
-[[_rgcms_methods_reserved_created]]
-= `created()`
-: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 `created()` lifecycle callback method is called when an object has just been created using xref: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`].
-====
-
-
-
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_jdo-api.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_jdo-api.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_jdo-api.adoc
deleted file mode 100644
index 61a97a1..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_jdo-api.adoc
+++ /dev/null
@@ -1,53 +0,0 @@
-[[_rgcms_methods_lifecycle_jdo-api]]
-= Using the JDO API
-: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/
-
-
-
-As an alternative to relying on Apache Isis to call lifecycle callback methods, you could instead use the JDO link:http://www.datanucleus.org/products/datanucleus/jdo/lifecycle_callbacks.html[lifecycle listener] API directly.
-
-[NOTE]
-====
-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.
-
-For example:
-
-[source,java]
-----
-@RequestScoped // <1>
-@DomainService(nature=NatureOfService.DOMAIN)
-public class ObjectChangedListenerService
- implements javax.jdo.listener.StoreLifecycleListener { // <2>
- @Programmatic
- @PostConstruct
- public void init() {
- getPmFactory().addInstanceLifecycleListener(this);
- }
- @Programmatic
- @PreDestroy
- public void tidyUp() {
- getPmFactory().removeInstanceLifecycleListener(this);
- }
- private PersistenceManager getPersistenceManager() {
- return jdoSupport.getPersistenceManager(); // <3>
- }
- @Programmatic
- public void preStore (InstanceLifecycleEvent event) { ... }
- @Programmatic
- public void postStore (InstanceLifecycleEvent event) { ... }
- @Inject
- IsisJdoSupport jdoSupport;
-}
-----
-<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`.
-
-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/2669a971/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_loaded.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_loaded.adoc b/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_loaded.adoc
deleted file mode 100644
index fe48807..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/_rgcms_methods_lifecycle_loaded.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
-[[_rgcms_methods_reserved_loaded]]
-= `loaded()`
-: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 `loaded()` lifecycle callback method is called when a (persistent) object has just been loaded from the object store.
-
-
-[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`].
-====