http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc index 7bb3fe2..00af60a 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcfg/_rgcfg_specifying-components.adoc @@ -11,7 +11,7 @@ Bootstrapping an Apache Isis application involves identifying both: * the major components (authentication, persistence mechanisms, viewers) of Apache Isis, and also * specifying the domain services and persistent entities that make up the application itself. -As of 1.9.0 there are two different ways to perform this bootstrapping. The recommended (newer) approach is to use an xref:rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`], specified either programmatically or through the configuration properties. This allows the components, services and entities to be specified from a single class. The alternative (and older, pre 1.9.0) approach is to specify this information individually, through configuration properties. +As of 1.9.0 there are two different ways to perform this bootstrapping. The recommended (newer) approach is to use an xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`], specified either programmatically or through the configuration properties. This allows the components, services and entities to be specified from a single class. The alternative (and older, pre 1.9.0) approach is to specify this information individually, through configuration properties. To specify the `AppManifest` as a configuration property, use: @@ -27,7 +27,7 @@ To specify the `AppManifest` as a configuration property, use: |`FQCN` |`o.a.i.applib.AppManifest` + -By convention this implementation resides in an `myapp-app` Maven module (as opposed to `myapp-dom` or `myapp-fixture`). See the xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] for details. +By convention this implementation resides in an `myapp-app` Maven module (as opposed to `myapp-dom` or `myapp-fixture`). See the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] for details. |=== @@ -49,7 +49,7 @@ If the `AppManifest` approach is _not_ being used, then the following configurat (`_shiro_`) |`o.a.i.core.runtime.authentication.` `AuthenticationManagerInstaller` + -This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. +This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. |`isis.authorization` @@ -57,7 +57,7 @@ This property is IGNORED if the `isis.appManifest` configuration property is spe (`_shiro_`) |`o.a.i.core.runtime.authorization.` `AuthorizationManagerInstaller` + -This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. +This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. |`isis.persistor` |`datanucleus` @@ -80,7 +80,7 @@ The mechanism to discover and load domain services: * Otherwise an alternative implementation of the `o.a.i.core.runtime.services.ServicesInstaller` internal API can be provided. + -This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. +This property is IGNORED if the `isis.appManifest` configuration property is specified, or if an xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AppManifest[`AppManifest`] is provided programmatically. This property is also IGNORED completely in 1.13.0+; the `configuration-and-annotation` implementation is always used.
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes.adoc index 3cb8b4f..213d973 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -This chapter describes the usage of various classes and interfaces that are not otherwise associated with xref:rgsvc.adoc[domain services], xref:ugvw.adoc#_ugvw_layout[object layout] or xref:rgcfg.adoc#_rgcfg[configuration]. +This chapter describes the usage of various classes and interfaces that are not otherwise associated with xref:../rgsvc/rgsvc.adoc[domain services], xref:ugvw.adoc#_ugvw_layout[object layout] or xref:../rgcfg/rgcfg.adoc#_rgcfg[configuration]. include::_rgcms_classes_AppManifest-bootstrapping.adoc[leveloffset=+1] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc index ca292de..d80fd36 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_AppManifest-bootstrapping.adoc @@ -39,7 +39,7 @@ The following sections describe each of these methods in a little more detail. === `getModules()` -The most significant method (the only one which must return a non-`null` value) is the `getModules()` method. Each module is identified by a class; the framework simply uses that class' package as the root to search for domain services (annotated with xref:rgant.adoc#_rgant-DomainService[`@DomainService`]) and entities (annotated with xref:rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`]). Generally there is one such module class per Maven module. +The most significant method (the only one which must return a non-`null` value) is the `getModules()` method. Each module is identified by a class; the framework simply uses that class' package as the root to search for domain services (annotated with xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`]) and entities (annotated with xref:../rgant/rgant.adoc#_rgant-PersistenceCapable[`@PersistenceCapable`]). Generally there is one such module class per Maven module. A module class for a domain module might for example be defined as: @@ -82,7 +82,7 @@ As can be seen, the various (non-ASF) link:http://isisaddons.org[Isis Addons] mo === `getAdditionalServices()` -We normally we recommend that services are defined exclusively through `getModules()`, and that this method should therefore return an empty list. However, there are certain use cases where the a service must be explicitly specified either because the service required does not (for whatever reason) have a xref:rgant.adoc#_rgant-DomainService[`@DomainService`] annotation. +We normally we recommend that services are defined exclusively through `getModules()`, and that this method should therefore return an empty list. However, there are certain use cases where the a service must be explicitly specified either because the service required does not (for whatever reason) have a xref:../rgant/rgant.adoc#_rgant-DomainService[`@DomainService`] annotation. For example, the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module (v1.9.0) allows the policy to evaluate conflicting permissions to be specified by explicitly registering either the `PermissionsEvaluationServiceAllowBeatsVeto` domain service or the `PermissionsEvaluationServiceVetoBeatsAllow` domain service: @@ -208,7 +208,7 @@ public interface AppManifest { (disable persistence by reachability, support mixed case identifiers, disable level 2 cache) <3> sets up standard properties for the Apache Isis framework, most specifically to enable fixtures to be installed. -For example, the bootstrapping code for the xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] looks something like: +For example, the bootstrapping code for the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype] looks something like: [source,java] ---- http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc index 59cde44..6b825c5 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_contributee_HasTransactionId.adoc @@ -6,7 +6,7 @@ The `HasTransactionId` interface is a mix-in for any domain objects that reference a transaction id, such as -auditing entries or commands, or for xref:rgsvc.adoc#_rgsvc_api_InteractionContext[``Interaction``]s persisted as +auditing entries or commands, or for xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[``Interaction``]s persisted as published events. [NOTE] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc index d7a1586..bc18d88 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent.adoc @@ -7,8 +7,8 @@ This section catalogues the various domain event classes defined by Apache Isis. -These events are broadcast on the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. The domain -events are broadcast as a result of being specified in the xref:rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`], xref:rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`] or xref:rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`] attributes. +These events are broadcast on the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. The domain +events are broadcast as a result of being specified in the xref:../rgant/rgant.adoc#_rgant-Action_domainEvent[`@Action#domainEvent()`], xref:../rgant/rgant.adoc#_rgant-Property_domainEvent[`@Property#domainEvent()`] or xref:../rgant/rgant.adoc#_rgant-Collection_domainEvent[`@Collection#domainEvent()`] attributes. They are listed in the table below. @@ -23,7 +23,7 @@ Impl'n (g: a:) |Notes -|xref:rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`o.a.i.applib.` + `AbstractDomainEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -32,7 +32,7 @@ Impl'n (g: a:) |Superclass of the other domain events, listed below in this table. -|xref:rgcms.adoc#_rgcms_classes_domainevent_ActionDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_ActionDomainEvent[`o.a.i.applib.` + `ActionDomainEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -42,7 +42,7 @@ Impl'n (g: a:) |Broadcast whenever there is an interaction (hide/disable/validate/pre-execute/post-execute) with an object's action. -|xref:rgcms.adoc#_rgcms_classes_domainevent_CollectionDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_CollectionDomainEvent[`o.a.i.applib.` + `CollectionDomainEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -53,7 +53,7 @@ is specified. |Broadcast whenever there is an interaction (hide/disable/validate/access) with an object's collection. -|xref:rgcms.adoc#_rgcms_classes_domainevent_PropertyDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_PropertyDomainEvent[`o.a.i.applib.` + `PropertyDomainEvent`] |``o.a.i.core`` + ``services.eventbus`` + http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_AbstractDomainEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_AbstractDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_AbstractDomainEvent.adoc index 7740763..2828b89 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_AbstractDomainEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_AbstractDomainEvent.adoc @@ -10,11 +10,11 @@ properties or collections. Its immediate subclasses are: -* xref:rgcms.adoc#_rgcms_classes_domainevent_ActionDomainEvent[`ActionDomainEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_ActionDomainEvent[`ActionDomainEvent`] -* xref:rgcms.adoc#_rgcms_classes_domainevent_PropertyDomainEvent[`PropertyDomainEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_PropertyDomainEvent[`PropertyDomainEvent`] -* xref:rgcms.adoc#_rgcms_classes_domainevent_CollectionDomainEvent[`CollectionDomainEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_CollectionDomainEvent[`CollectionDomainEvent`] The main purpose of the class is to define the protocol by which subscribers can influence an interaction (eg hide a collection, disable a property, validate action arguments). It class also provides a simple mechanism to allow http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc index 8b0713e..05a3ef9 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_ActionDomainEvent.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for actions. +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for actions. The class has a number of responsibilities (in addition to those it inherits): @@ -15,7 +15,7 @@ The class has a number of responsibilities (in addition to those it inherits): * provide selected metadata about the action parameters from the metamodel (names, types) -* link back to the xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service's `Command` object +* link back to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] service's `Command` object The class itself is instantiated automatically by the framework whenever interacting with a rendered object's action. @@ -44,12 +44,12 @@ public abstract class ActionDomainEvent<S> extends AbstractDomainEvent<S> { public Object getReturnValue(); // <7> } ---- -<1> The `Default` nested static class is the default for the xref:rgant.adoc#_rgant_Action_domainEvent[`@Action#domainEvent()`] +<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Action_domainEvent[`@Action#domainEvent()`] annotation attribute. Whether this raises an event or not depends upon the `isis.reflector.facet.actionAnnotation.domainEvent.postForDefault` configuration property. <2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting). <3> Similarly, the `Doop` class is provided as a convenience to indicate that an event _should_ be raised (irrespective of the configuration property setting). -<4> Deprecated, use xref:rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] or (better) xref:rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`]instead. +<4> Deprecated, use xref:../rgsvc/rgsvc.adoc#_rgsvc_api_CommandContext[`CommandContext`] or (better) xref:../rgsvc/rgsvc.adoc#_rgsvc_api_InteractionContext[`InteractionContext`]instead. <5> Populated only for mixins; holds the underlying domain object that the mixin contributes to. <6> The arguments being used to invoke the action; populated during validate phase and subsequent phases. <7> The value returned by the action; populated only in the executed phase. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc index f96bb4a..a258cfa 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_CollectionDomainEvent.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for collections. +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for collections. The class has a couple of responsibilities (in addition to those it inherits): @@ -38,7 +38,7 @@ public abstract class CollectionDomainEvent<S,T> extends AbstractDomainEvent<S> public Of getOf(); // <5> } ---- -<1> The `Default` nested static class is the default for the xref:rgant.adoc#_rgant_Collection_domainEvent[`@Collection#domainEvent()`] +<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Collection_domainEvent[`@Collection#domainEvent()`] annotation attribute. Whether this raises an event or not depends upon the `isis.reflector.facet.collectionAnnotation.domainEvent.postForDefault` configuration property. <2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc index e6649ff..a2d16b5 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_domainevent_PropertyDomainEvent.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for properties. +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_domainevent_AbstractDomainEvent[`AbstractDomainEvent`] for properties. The class has a couple of responsibilities (in addition to those it inherits): @@ -36,7 +36,7 @@ public abstract class PropertyDomainEvent<S,T> extends AbstractDomainEvent<S> { public T getNewValue(); // <5> } ---- -<1> The `Default` nested static class is the default for the xref:rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`] +<1> The `Default` nested static class is the default for the xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`] annotation attribute. Whether this raises an event or not depends upon the `isis.reflector.facet.propertyAnnotation.domainEvent.postForDefault` configuration property. <2> The `Noop` class is provided as a convenience to indicate that an event should _not_ be posted (irrespective of the configuration property setting). http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc index f8d3734..bcd821d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_layout.adoc @@ -15,9 +15,9 @@ The `org.apache.isis.applib.layout` package defines a number of classes that all The framework provides an implementation of the grid classes modelled closely on link:http://getbootstrap.com[Bootstrap 3], along with xref:ugvw.adoc[Wicket viewer] components capable of rendering that grid system. In principle it is also possible to extend the layout architecture for other grid systems. The component classes, though, are intended to be reusable across all grid systems. -The component classes, meanwhile, are broadly equivalent to the "layout" annotations (xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`], xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] and xref:rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`] +The component classes, meanwhile, are broadly equivalent to the "layout" annotations (xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] and xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`] -All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the `component` classes in the `http://isis.apache.org/applib/layout/component` XSD namespace, the bootstrap 3 grid classes in the `http://isis.apache.org/applib/layout/grid/bootstrap3` XSD namespace). This ability to serialize to/from XML is used by the xref:rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`], the default implementation of which reads the grid layout for a domain class from a `.layout.xml` file on the classpath. +All of the classes in this package are JAXB-annotated, meaning that they can be serialized to/from XML (the `component` classes in the `http://isis.apache.org/applib/layout/component` XSD namespace, the bootstrap 3 grid classes in the `http://isis.apache.org/applib/layout/grid/bootstrap3` XSD namespace). This ability to serialize to/from XML is used by the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridLoaderService[`GridLoaderService`], the default implementation of which reads the grid layout for a domain class from a `.layout.xml` file on the classpath. @@ -33,13 +33,13 @@ A fieldset (previously also called a property group or member group) of a number * layout data classes, which correspond to the similarly named annotations: -** `PropertyLayoutData`, corresponding to the xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] annotation; +** `PropertyLayoutData`, corresponding to the xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] annotation; -** `CollectionLayoutData`, corresponding to the xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] annotation; +** `CollectionLayoutData`, corresponding to the xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`] annotation; -** `ActionLayoutData`, corresponding to the xref:rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] annotation; +** `ActionLayoutData`, corresponding to the xref:../rgant/rgant.adoc#_rgant-ActionLayout[`@ActionLayout`] annotation; -** `DomainObjectLayoutData`, corresponding to the xref:rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`] annotation. +** `DomainObjectLayoutData`, corresponding to the xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout[`@DomainObjectLayout`] annotation. In addition, the component package includes `Grid`, representing the top level container for a custom layout for a domain object. `Grid` itself is merely an interface, but it also defines the visitor pattern to make it easy for validate and normalize the grid layouts. The `GridAbstract` convenience superclass provides a partial implementation of this visitor pattern. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc index a16eb73..e01f067 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent.adoc @@ -22,7 +22,7 @@ Impl'n (g: a:) |Notes -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`o.a.i.applib.` + +|xref:../rgcms/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_ObjectCreatedDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedDomainEvent[`o.a.i.applib.` + `ObjectCreatedEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -39,11 +39,11 @@ Impl'n (g: a:) |(abstract class). + `ObjectCreatedEvent.Default` is the concrete implementation that is used. |Broadcast when an object is first instantiated -using the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s +using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s `#newTransientInstance(...)` method. -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/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_ObjectPersistedDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedDomainEvent[`o.a.i.applib.` + `ObjectPersistedEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -61,11 +61,11 @@ using the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[` |(abstract class). + `ObjectPersistedEvent.Default` is the concrete implementation that is used. |Broadcast when an object is first saved (inserted) into the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#persist(...)` method. -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingDomainEvent[`o.a.i.applib.` + `ObjectPersistingEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -73,11 +73,11 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainO |(abstract class). + `ObjectPersistingEvent.Default` is the concrete implementation that is used. |Broadcast when an object is about to be saved (inserted) into the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#persist(...)` method. -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingDomainEvent[`o.a.i.applib.` + `ObjectRemovingEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -85,11 +85,11 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainO |(abstract class). + `ObjectRemovingEvent.Default` is the concrete implementation that is used. |Broadcast when an object is about to be deleted from the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#remove(...)` method. -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedDomainEvent[`o.a.i.applib.` + `ObjectUpdatedEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -98,11 +98,11 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainO `ObjectUpdatedEvent.Default` is the concrete implementation that is used. |Broadcast when an object has just been updated in the database. This is done either explicitly when the current transaction is flushed using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/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. -|xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingDomainEvent[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingDomainEvent[`o.a.i.applib.` + `ObjectUpdatingEvent`] |``o.a.i.core`` + ``services.eventbus`` + @@ -111,7 +111,7 @@ xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainO `ObjectUpdatingEvent.Default` is the concrete implementation that is used. |Broadcast when an object is about to be updated in the database. This is done either explicitly when the current transaction is flushed using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/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. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc index 92dd0d5..070e6d1 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_AbstractLifecycleEvent.adoc @@ -10,18 +10,18 @@ or deleting objects from the database. Its immediate subclasses are: -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedEvent[`ObjectCreatedEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectCreatedEvent[`ObjectCreatedEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedEvent[`ObjectLoadedEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectLoadedEvent[`ObjectLoadedEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedEvent[`ObjectPersistedEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistedEvent[`ObjectPersistedEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingEvent[`ObjectPersistingEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectPersistingEvent[`ObjectPersistingEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingEvent[`ObjectRemovingEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectRemovingEvent[`ObjectRemovingEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedEvent[`ObjectUpdatedEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatedEvent[`ObjectUpdatedEvent`] -* xref:rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingEvent[`ObjectUpdatingEvent`] +* xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_ObjectUpdatingEvent[`ObjectUpdatingEvent`] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc index 4aa52ad..3b1e931 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectCreatedEvent.adoc @@ -6,9 +6,9 @@ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/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 +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[`DomainObjectContainer`]'s `#newTransientInstance(...)` method. `ObjectCreatedEvent.Default` is the concrete implementation that is used. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc index ce7fb9a..8bcd12d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectLoadedEvent.adoc @@ -6,7 +6,7 @@ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is retrieved from the database. `ObjectLoadedEvent.Default` is the concrete implementation that is used. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc index d94f09c..179f65b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistedEvent.adoc @@ -5,9 +5,9 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is first saved (inserted) into the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#persist(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc index cc628df..7bde9cd 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectPersistingEvent.adoc @@ -5,9 +5,9 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be saved (inserted) into the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#persist(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc index 9e71dfb..263e7a0 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectRemovingEvent.adoc @@ -5,9 +5,9 @@ :_imagesdir: images/ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be deleted from the database using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s `#remove(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc index 5963c12..862c104 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatedEvent.adoc @@ -6,10 +6,10 @@ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object has just been updated in the database. This is done either explicitly when the current transaction is flushed using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/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. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc index 65edd94..abfdd3d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_lifecycleevent_ObjectUpdatingEvent.adoc @@ -6,10 +6,10 @@ -Subclass of xref:rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast +Subclass of xref:../rgcms/rgcms.adoc#_rgcms_classes_lifecycleevent_AbstractLifecycleEvent[`AbstractLifecycleEvent`], broadcast when an object is about to be updated in the database. This is done either explicitly when the current transaction is flushed using the -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-persistence-api[`DomainObjectContainer`]'s +xref:../rgsvc/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. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc index 3f019a6..9c4585a 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Dto.adoc @@ -6,7 +6,7 @@ The `Dto` role interface 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 +xref:../rgant/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_decoupling_mixins[mixins], `Dto_downloadXml` and `Dto_downloadXsd`. @@ -32,7 +32,7 @@ public class Dto_downloadXml { <2> actually this method is called '$$' in the code, a "special case" that means to use the derive the action name from the class name. -This will return the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. +This will return the XML text wrapped up in a xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. The `Dto_downloadXsd` mixin is similar: @@ -48,10 +48,10 @@ public class Dto_downloadXsd { <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 +a xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`] of that XSD. If there are multiple XSD schemas referenced then the action will return a zip of those schemas, wrapped up in a -xref:rgcms.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 +xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`]. The `IsisSchemas` parameter to the action can be used to +optionally ignore the common xref:../rgcms/rgcms.adoc#_rgcms_schema[Apache Isis schemas] (useful if there is only one other XSD schema referenced by the DTO). @@ -59,4 +59,4 @@ 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 +xref:../rgsvc/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/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc index 21bed1b..ef0b283 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Object.adoc @@ -39,7 +39,7 @@ This mixin actions are all associated with the "Metadata" fieldset. If there is === Related Services -This mixin uses the xref:rgsvc.adoc#_rgsvc_spi_HintStore[`HintStore`] service to store and retrieve UI hints for +This mixin uses the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_HintStore[`HintStore`] service to store and retrieve UI hints for each rendered object, per user. @@ -61,20 +61,20 @@ public Object downloadLayoutXml( <1> either current, complete, normalized or minimal. See the documentation on xref:ugvw.adoc#_ugvw_layout_file-based[layout XML] and also -the xref:rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`] for more information on these styles +the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`] for more information on these styles === Appearance in the UI This mixin actions are all associated with the "Metadata" fieldset. -A number of other xref:rgcms.adoc#_rgcms_classes_mixins_Persistable[mixins] also contribute properties and actions to the "Metadata" fieldset. +A number of other xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Persistable[mixins] also contribute properties and actions to the "Metadata" fieldset. === Related Services -This mixin calls xref:rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`] to obtain the layout XML. +This mixin calls xref:../rgsvc/rgsvc.adoc#_rgsvc_api_LayoutService[`LayoutService`] to obtain the layout XML. @@ -98,14 +98,14 @@ public void rebuildMetamodel() { This mixin actions are all associated with the "Metadata" fieldset. -A number of other xref:rgcms.adoc#_rgcms_classes_mixins_Persistable[mixins] also contribute properties and actions to +A number of other xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Persistable[mixins] also contribute properties and actions to the "Metadata" fieldset. === Related Services -This mixin calls xref:rgsvc.adoc#_rgsvc_api_MetaModelService[`MetaModelService`] and the -xref:rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] to invalidate their caches. +This mixin calls xref:../rgsvc/rgsvc.adoc#_rgsvc_api_MetaModelService[`MetaModelService`] and the +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_GridService[`GridService`] to invalidate their caches. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc index fb6e930..28e3c89 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_mixins_Persistable.adoc @@ -23,18 +23,18 @@ public Clob downloadJdoMetadata( // <1> ... } ---- -<1> returns the XML text wrapped up in a xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. +<1> returns the XML text wrapped up in a xref:../rgcms/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. +These mixin properties are all associated with the "Metadata" fieldset. The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset. === Related Services -The mixin delegates to the xref:rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service to obtain +The mixin delegates to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_IsisJdoSupport[`IsisJdoSupport`] service to obtain a reference to the JDO `PersistenceManagerFactory`. @@ -51,6 +51,6 @@ The framework provides a number of mixins that expose the datanucleus Id and ver === 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. +These mixin properties are all associated with the "Metadata" fieldset. The xref:../rgcms/rgcms.adoc#_rgcms_classes_mixins_Object[Object mixin] also contribute an action to the "Metadata" fieldset. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc index f85dccb..c3a2351 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedAt.adoc @@ -17,9 +17,9 @@ public interface HoldsUpdatedAt { } ---- -The current time is obtained from the xref:rgsvc.adoc#_rgsvc_api_ClockService[`ClockService`]. +The current time is obtained from the xref:../rgsvc/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. +Entities that implement this interface often also implement xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] role interface; as a convenience the xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] interface combines the two roles. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc index d34b295..b7781be 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_HoldsUpdatedBy.adoc @@ -14,6 +14,6 @@ public interface HoldsUpdatedBy { } ---- -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. +Entities that implement this interface often also implement xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] role interface; as a convenience the xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] interface combines the two roles. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc index 3b73e71..154b15d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_roles_Timestampable.adoc @@ -5,7 +5,7 @@ :_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: +The `Timestampable` role interface is a convenience that combines the xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedAt[`HoldsUpdatedAt`] and xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] interfaces. It is defined as: [source,java] ---- @@ -20,4 +20,4 @@ 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. +An alternative way to maintain a timestamp is to use JDO's `@Version` annotation. With this approach, it is the JDO/DataNucleus that maintains the version, rather than the framework's `TimestampService`. See xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_HoldsUpdatedBy[`HoldsUpdatedBy`] for further details. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc index 73267a3..3dc93b6 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_spec.adoc @@ -7,7 +7,7 @@ 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()`]). +Apache Isis will automatically apply such specifications as validation rules on properties (as per xref:../rgant/rgant.adoc#_rgant-Property_mustSatisfy[`@Property#mustSatisfy()`]) and on action parameters (as per xref:../rgant/rgant.adoc#_rgant-Parameter_mustSatisfy[`@Parameter#mustSatisfy()`]). @@ -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_TranslatableString[translatable string]: +The `Specification2` interface extends the `Specification` API to add support for i18n. This is done by defining an additional method that returns a xref:../rgcms/rgcms.adoc#_rgcms_classes_i18n_TranslatableString[translatable string]: [source,java] ---- http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc index b194d86..c0c7f5e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super.adoc @@ -19,7 +19,7 @@ Impl'n (g: a:) |Notes -|xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`o.a.i.applib.` + +|xref:../rgcms/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_AbstractDomainObject[`o.a.i.applib.` + +|xref:../rgcms/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_AbstractFactoryAndRepository[`o.a.i.applib.` + +|xref:../rgcms/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_AbstractService[`o.a.i.applib.` + +|xref:../rgcms/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_AbstractSubscriber[`o.a.i.applib.` + +|xref:../rgcms/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_AbstractViewModel[`o.a.i.applib.` + +|xref:../rgcms/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_FixtureScript[`o.a.i.applib.` + +|xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`o.a.i.applib.` + `fixturescript` + `FixtureScript`] |``o.a.i.core`` + @@ -76,13 +76,13 @@ Impl'n (g: a:) | -|xref:rgcms.adoc#_rgcms_classes_super_FixtureScripts[`o.a.i.applib.` + +|xref:../rgcms/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 +`FixtureScriptsDefault` is a default implementation that is used when the alternative xref:../rgsvc/rgsvc.adoc#_rgsvc_api_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] is provided (and no other implementation of `FixtureScripts` was found). |depends on: + `ClassDiscoveryService` http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc index 14adf2c..2b77886 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractContainedObject.adoc @@ -23,10 +23,10 @@ when the transaction is flushed (typically when a query is performed). * `getContainer()` - which returns the `DomainObjectContainer` -Each of these methods simply delegates to an equivalent method in xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +Each of these methods simply delegates to an equivalent method in xref:../rgsvc/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. +In practice we find that there's little to gain from subclassing; it's easier/less obscure to simply inject xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`] into a simple pojo class. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc index 6edc5ee..298c132 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractDomainObject.adoc @@ -5,10 +5,10 @@ :_imagesdir: images/ -This class extends xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding +This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding in convenience methods for managing the persistence lifecycle of the object instance. Each of these methods, eg `isPersistent(...)`, delegates to an equivalent method in -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc index 50d283e..d103cf6 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractFactoryAndRepository.adoc @@ -5,11 +5,11 @@ :_imagesdir: images/ -This class extends xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`]. Its +This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`]. Its intent was to be a convenience subclass for services acting as either a repository or a factory, however note that all of the methods that it defines are now deprecated. -Instead, indicate that a service is repository using the xref:rgant.adoc#_rgant-DomainService_repositoryFor[`@DomainService#repositoryFor()`] attribute. +Instead, indicate that a service is repository using the xref:../rgant/rgant.adoc#_rgant-DomainService_repositoryFor[`@DomainService#repositoryFor()`] attribute. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc index 2174b79..30c1c54 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractService.adoc @@ -4,7 +4,7 @@ :_basedir: ../../ :_imagesdir: images/ -This class extends xref:rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding +This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], adding in an implementation of `getId()` based upon the classes name. -In practice there is little to gain from subclassing; simply inject xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`] for broadly equivalent functionality. +In practice there is little to gain from subclassing; simply inject xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`] for broadly equivalent functionality. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc index f42aeee..2b3f6ea 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractSubscriber.adoc @@ -5,14 +5,14 @@ :_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 +This is a convenience superclass for creating subscriber domain services on the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. It uses xref:../rgant/rgant.adoc#_rgant-PostConstruct[`@PostConstruct`] and +xref:../rgant/rgant.adoc#_rgant-PreDestroy[`@PreDestroy`] callbacks to automatically register/unregister itself with the `EventBusService`. It's important that subscribers register before any domain services that might emit events on the -xref:rgsvc.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 +xref:../rgsvc/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/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. +xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute. As a convenience, the `AbstractSubscriber` specifies this attribute. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc index a4e32ad..2e2c042 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_AbstractViewModel.adoc @@ -5,8 +5,8 @@ :_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. +This class extends xref:../rgcms/rgcms.adoc#_rgcms_classes_super_AbstractContainedObject[`AbstractContainedObject`], also +implementing the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface. In and of itself it provides no new behaviour. [TIP] ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc index 2850624..04a8e60 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_super_FixtureScripts.adoc @@ -4,9 +4,9 @@ :_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. +This abstract class is intended to allow a domain service that can execute xref:../rgcms/rgcms.adoc#_rgcms_classes_super_FixtureScript[`FixtureScript`]s to be easily written. -However, it has now been deprecated; instead we recommend that the xref:rgsvc.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. +However, it has now been deprecated; instead we recommend that the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_FixtureScriptsSpecificationProvider[`FixtureScriptsSpecificationProvider`] service is +implemented instead. The framework will then automatically use xref:../rgsvc/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/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent.adoc index ce83395..0078668 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent.adoc @@ -7,8 +7,8 @@ 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. +These events are broadcast on the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`]. The domain +events are broadcast as a result of being specified in the xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`@DomainObjectLayout#titleUiEvent()`], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`@DomainObjectLayout#iconUiEvent()`] or xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`@DomainObjectLayout#cssClassUiEvent()`] attributes. They are listed in the table below. @@ -23,32 +23,32 @@ Impl'n (g: a:) |Notes -|xref:rgcms.adoc#_rgcms_classes_uievent_TitleUiEvent[`o.a.i.applib.` + +|xref:../rgcms/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. +|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/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] supporting method, or has xref:../rgant/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.` + +|xref:../rgcms/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. +|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/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] supporting method, or if it has the xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout#cssClassFa[`@DomainObjectLayout#cssClassFa()`] attribute, then these will take precedence. -|xref:rgcms.adoc#_rgcms_classes_uievent_CssClassUiEvent[`o.a.i.applib.` + +|xref:../rgcms/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 +|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/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] supporting method then this will take precedence. |=== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_CssClassUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_CssClassUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_CssClassUiEvent.adoc index e1776e7..2403491 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_CssClassUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_CssClassUiEvent.adoc @@ -17,6 +17,6 @@ The class itself is instantiated automatically by the framework whenever interac [NOTE] ==== -if the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] supporting +if the domain object defines its own xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] supporting method then this will take precedence. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_IconUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_IconUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_IconUiEvent.adoc index 5e47a36..7adfcd0 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_IconUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_IconUiEvent.adoc @@ -16,8 +16,8 @@ The class itself is instantiated automatically by the framework whenever interac [NOTE] ==== -If the domain object defines its own xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] supporting method, +If the domain object defines its own xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] supporting method, or if it has the -xref:rgant.adoc#_rgant-DomainObjectLayout#cssClassFa[`@DomainObjectLayout#cssClassFa()`] attribute, then +xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout#cssClassFa[`@DomainObjectLayout#cssClassFa()`] attribute, then these will take precedence. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_TitleUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_TitleUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_TitleUiEvent.adoc index 9218b6f..84415d4 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_TitleUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_uievent_TitleUiEvent.adoc @@ -16,7 +16,7 @@ The class itself is instantiated automatically by the framework whenever interac [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 +If the domain object defines its own xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] supporting method, or +has xref:../rgant/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/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_TitleBuffer.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_TitleBuffer.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_TitleBuffer.adoc index 0030b18..fab11ff 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_TitleBuffer.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_utility_TitleBuffer.adoc @@ -5,7 +5,7 @@ :_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). +The `TitleBuffer` utility class is intended to make it easy to construct title strings (returned from the xref:../rgcms/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/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Blob.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Blob.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Blob.adoc index 3850c5b..14c7143 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Blob.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Blob.adoc @@ -46,5 +46,5 @@ private Blob someImage; [TIP] ==== -For character large objects, use xref:rgcms.adoc#_rgcms_classes_value-types_Clob][`Clob`] value type. +For character large objects, use xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob][`Clob`] value type. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Clob.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Clob.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Clob.adoc index 3c51930..99ad6d3 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Clob.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_classes_value-types_Clob.adoc @@ -50,7 +50,7 @@ private Clob someClob; [TIP] ==== -For binary large objects, use xref:rgcms.adoc#_rgcms_classes_value-types_Blob][`Blob`] value type. +For binary large objects, use xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob][`Blob`] value type. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods.adoc index 913032e..f6c6cf0 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgcms/_rgcms_methods.adoc @@ -6,7 +6,7 @@ -The Apache Isis metamodel is built up from declaratively (ie, xref:rgant.adoc#_rgant[annotations]) and imperatively, from "supporting" methods and other reserved methods. +The Apache Isis metamodel is built up from declaratively (ie, xref:../rgant/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.
