http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout.adoc index 2ce1cf5..df4b445 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout.adoc @@ -11,7 +11,7 @@ The `@DomainObjectLayout` annotation applies to domain classes, collecting toget [NOTE] ==== -For view models that have been annotated with `@ViewModel` the equivalent xref:rgant.adoc#_rgant-ViewModelLayout[`@ViewModelLayout`] can be used. +For view models that have been annotated with `@ViewModel` the equivalent xref:../rgant/rgant.adoc#_rgant-ViewModelLayout[`@ViewModelLayout`] can be used. ==== @@ -26,18 +26,18 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-DomainObjectLayout_bookmarking[`bookmarking()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_bookmarking[`bookmarking()`] |`AS_ROOT`, `AS_CHILD`, `NEVER` + (`NEVER`) |whether (and how) this domain object should be automatically bookmarked -|xref:rgant.adoc#_rgant-DomainObjectLayout_cssclass[`cssClass()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssclass[`cssClass()`] |Any string valid as a CSS class -|the css class that a domain class (type) should have, to allow more targetted styling in xref:rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] +|the css class that a domain class (type) should have, to allow more targetted styling in xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[`application.css`] -|xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[`cssClassFa()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[`cssClassFa()`] |Any valid link:http://fortawesome.github.io/Font-Awesome/[Font awesome] icon name |specify a font awesome icon for the action's menu link or icon. + @@ -48,41 +48,41 @@ The table below summarizes the annotation's attributes. |Currently unused. -|xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassUiEvent[`cssClassUiEvent()`] |subtype of `CssClassUiEvent` + (`CssClassUiEvent.Default`) -|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain a CSS class for the domain object. +|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain a CSS class for the domain object. -|xref:rgant.adoc#_rgant-DomainObjectLayout_describedAs[`describedAs()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_describedAs[`describedAs()`] |String. |description of this class, eg to be rendered in a tooltip. -|xref:rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`iconUiEvent()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_iconUiEvent[`iconUiEvent()`] |subtype of `IconUiEvent` + (`IconUiEvent.Default`) -|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain the icon (name) for the domain object. +|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain the icon (name) for the domain object. -|xref:rgant.adoc#_rgant-DomainObjectLayout_named[`named()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[`named()`] |String. |to override the name inferred from the action's name in code. + A typical use case is if the desired name is a reserved Java keyword, such as `default` or `package`. -|xref:rgant.adoc#_rgant-DomainObjectLayout_paged[`paged()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_paged[`paged()`] |Positive integer |the page size for instances of this class when rendered within a table (as returned from an action invocation) -|xref:rgant.adoc#_rgant-DomainObjectLayout_plural[`plural()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_plural[`plural()`] |String. |the plural name of the class -|xref:rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`titleUiEvent()`] +|xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_titleUiEvent[`titleUiEvent()`] |subtype of `TitleUiEvent` + (`TitleUiEvent.Default`) -|the event type to be posted to the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain the title for the domain object. +|the event type to be posted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] to obtain the title for the domain object. |===
http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_bookmarking.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_bookmarking.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_bookmarking.adoc index df60f6e..5829ea1 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_bookmarking.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_bookmarking.adoc @@ -6,7 +6,7 @@ -The `bookmarking()` attribute indicates that an entity is automatically bookmarked. This attribute is also supported for xref:rgant.adoc#_rgant-Action_bookmarking[domain objects]. +The `bookmarking()` attribute indicates that an entity is automatically bookmarked. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-Action_bookmarking[domain objects]. (In the Wicket viewer), a link to a bookmarked object is shown in the bookmarks panel: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClass.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClass.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClass.adoc index b9fefe8..27251fb 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClass.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClass.adoc @@ -6,9 +6,9 @@ -The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the domain object. xref:rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. +The `cssClass()` attribute can be used to render additional CSS classes in the HTML (a wrapping `<div>`) that represents the domain object. xref:../rgcfg/rgcfg.adoc#_rgcfg_application-specific_application-css[Application-specific CSS] can then be used to target and adjust the UI representation of that particular element. -This attribute can also be applied to xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. +This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[domain objects], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClass[view models], xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClass[actions] xref:../rgant/rgant.adoc#_rgant-PropertyLayout_cssClass[properties], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_cssClass[collections] and xref:../rgant/rgant.adoc#_rgant-ParameterLayout_cssClass[parameters]. For example: @@ -26,7 +26,7 @@ public class ToDoItem { ... } [NOTE] ==== -The similar xref:rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[`@DomainObjectLayout#cssClassFa()`] annotation attribute is also used as a hint to apply CSS, but in particular to allow http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icons] +The similar xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClassFa[`@DomainObjectLayout#cssClassFa()`] annotation attribute is also used as a hint to apply CSS, but in particular to allow http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icons] to be rendered as the icon for classes. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassFa.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassFa.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassFa.adoc index 3cdac13..4b25012 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassFa.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassFa.adoc @@ -8,9 +8,9 @@ The `cssClassFa()` attribute is used to specify the name of a link:http://fortawesome.github.io/Font-Awesome/icons/[Font Awesome icon] name, to be rendered as the domain object's icon. -These attributes can also be applied to xref:rgant.adoc#_rgant-ViewModelLayout_cssClassFa[view models] to specify the object's icon, and to xref:rgant.adoc#_rgant-ActionLayout_cssClassFa[actions] to specify an icon for the action's representation as a button or menu item. +These attributes can also be applied to xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_cssClassFa[view models] to specify the object's icon, and to xref:../rgant/rgant.adoc#_rgant-ActionLayout_cssClassFa[actions] to specify an icon for the action's representation as a button or menu item. -If necessary the icon specified can be overridden by a particular object instance using the xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] method. +If necessary the icon specified can be overridden by a particular object instance using the xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] method. @@ -32,7 +32,7 @@ The related `cssClassFaPosition()` attribute is currently unused for domain obje [TIP] ==== -The similar xref:rgant.adoc#_rgant-DomainObjectLayout_cssClass[`@DomainObjectLayout#cssClass()`] annotation attribute is also used as a hint +The similar xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_cssClass[`@DomainObjectLayout#cssClass()`] annotation attribute is also used as a hint to apply CSS, but for wrapping the representation of an object or object member so that it can be styled in an application-specific way. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassUiEvent.adoc index 30a7004..0b1f983 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_cssClassUiEvent.adoc @@ -7,16 +7,16 @@ Whenever a domain object is to be rendered, the framework fires off an CSS class UI event to obtain a CSS class to use in any wrapping ``<div>``s and ``<span>``s that render the domain object. This is as an alternative to implementing -xref:rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] reserved method. (If `cssClass()` is present, then +xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_cssClass[`cssClass()`] reserved method. (If `cssClass()` is present, then it will take precedence). -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use obtain a reference to the domain object from the event. From this they can, if they wish, specify a CSS class for the domain object using the event's API. [NOTE] ==== -The feature was originally introduced so that xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated +The feature was originally introduced so that xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated xref:ugbtb.adoc#_ugbtb_view-models[view model]s could be kept as minimal as possible, just defining the data. UI events allow subscribers to provide UI hints, while xref:ugbtb.adoc#_ugbtb_decoupling_mixins[mixin]s can be used to provide the behaviour. ==== @@ -56,7 +56,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): @@ -119,8 +119,8 @@ then no event will be posted. == Raising events programmatically Normally events are only raised for interactions through the UI. However, events can be raised programmatically either -by calling the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result -of calling the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s +by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result +of calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s `cssClassOf(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_describedAs.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_describedAs.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_describedAs.adoc index d275d3e..0c026da 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_describedAs.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_describedAs.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `describedAs()` attribute is used to provide a short description of the domain object to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The attribute can also be specified for xref:rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:rgant.adoc#_rgant-ParameterLayout_describedAs[parameters] and xref:rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. +The `describedAs()` attribute is used to provide a short description of the domain object to the user. In the xref:ugvw.adoc#[Wicket viewer] it is displayed as a 'tool tip'. The attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-CollectionLayout_describedAs[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_describedAs[properties], xref:../rgant/rgant.adoc#_rgant-ActionLayout_describedAs[actions], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_describedAs[parameters] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_describedAs[view models]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_iconUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_iconUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_iconUiEvent.adoc index fb97a35..2a48a2e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_iconUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_iconUiEvent.adoc @@ -7,17 +7,17 @@ Whenever a domain object is to be rendered, the framework fires off an icon UI event to obtain an icon (name) for the object (if possible). This is as an alternative to implementing -xref:rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] reserved method. (If `iconName()` is present, then +xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_iconName[`iconName()`] reserved method. (If `iconName()` is present, then it will take precedence). -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use obtain a reference to the domain object from the event. From this they can, if they wish, specify an icon name for the domain object using the event's API. [NOTE] ==== -The feature was originally introduced so that xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated +The feature was originally introduced so that xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated xref:ugbtb.adoc#_ugbtb_view-models[view model]s could be kept as minimal as possible, just defining the data. UI events allow subscribers to provide UI hints, while xref:ugbtb.adoc#_ugbtb_decoupling_mixins[mixin]s can be used to provide the behaviour. ==== @@ -57,7 +57,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): @@ -115,8 +115,8 @@ then no event will be posted. == Raising events programmatically Normally events are only raised for interactions through the UI. However, events can be raised programmatically either -by calling the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result -of calling the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s +by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result +of calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s `iconNameOf(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_named.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_named.adoc index 97c628c..4302409 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_named.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_named.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `named()` attribute explicitly specifies the domain object's name, overriding the name that would normally be inferred from the Java source code. The attribute can also be specified for xref:rgant.adoc#_rgant-ActionLayout_named[actions], xref:rgant.adoc#_rgant-CollectionLayout_named[collections], xref:rgant.adoc#_rgant-PropertyLayout_named[properties], xref:rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. +The `named()` attribute explicitly specifies the domain object's name, overriding the name that would normally be inferred from the Java source code. The attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models] and xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[domain services]. [TIP] @@ -26,7 +26,7 @@ public class CustomerImpl implements Customer{ } ---- -It's also possible to specify a xref:rgant.adoc#_rgant-DomainObjectLayout_plural[plural form] of the name, used by the framework when rendering a standalone collection of the domain object. +It's also possible to specify a xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_plural[plural form] of the name, used by the framework when rendering a standalone collection of the domain object. [TIP] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_paged.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_paged.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_paged.adoc index ccf0192..8380c1b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_paged.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_paged.adoc @@ -6,7 +6,7 @@ -The `paged()` attribute specifies the number of rows to display in a standalone collection, as returned from an action invocation. This attribute can also be applied to xref:rgant.adoc#_rgant-CollectionLayout_paged[collections] and xref:rgant.adoc#_rgant-ViewModelLayout_paged[view models]. +The `paged()` attribute specifies the number of rows to display in a standalone collection, as returned from an action invocation. This attribute can also be applied to xref:../rgant/rgant.adoc#_rgant-CollectionLayout_paged[collections] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_paged[view models]. [WARNING] @@ -28,6 +28,6 @@ public class Order { ---- -It is also possible to specify a global default for the page size of standalone collections, using the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.viewer.paged.standalone`. +It is also possible to specify a global default for the page size of standalone collections, using the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.viewer.paged.standalone`. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_plural.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_plural.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_plural.adoc index 1a6191f..60c38fc 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_plural.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_plural.adoc @@ -10,7 +10,7 @@ When Apache Isis displays a standalone collection of several objects, it will la By default the plural name will be derived from the end of the singular name, with support for some basic English language defaults (eg using "ies" for names ending with a "y"). -The `plural()` attribute allows the plural form of the class name to be specified explicitly. This attribute is also supported for xref:rgant.adoc#_rgant-ViewModelLayout_plural[view models]. +The `plural()` attribute allows the plural form of the class name to be specified explicitly. This attribute is also supported for xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_plural[view models]. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_titleUiEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_titleUiEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_titleUiEvent.adoc index 67ca08e..a36a421 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_titleUiEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObjectLayout_titleUiEvent.adoc @@ -6,17 +6,17 @@ Whenever a domain object is to be rendered, the framework fires off a title UI event to obtain a title for the object. -This is as an alternative to implementing xref:rgcms.adoc#_rgcms_methods_reserved_title[`title()`] reserved method, or -using the xref:rgant.adoc#_rgant-Title[`@Title`] annotation, within the class itself. (If either +This is as an alternative to implementing xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_title[`title()`] reserved method, or +using the xref:../rgant/rgant.adoc#_rgant-Title[`@Title`] annotation, within the class itself. (If either `title()` or `@Title` are present, then they will take precedence). -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use obtain a reference to the domain object from the event. From this they can, if they wish, specify a title for the domain object using the event's API. [NOTE] ==== -The feature was originally introduced so that xref:rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated +The feature was originally introduced so that xref:../rgant/rgant.adoc#_rgant-XmlRootElement[`@XmlRootElement`]-annotated xref:ugbtb.adoc#_ugbtb_view-models[view model]s could be kept as minimal as possible, just defining the data. UI events allow subscribers to provide UI hints, while xref:ugbtb.adoc#_ugbtb_decoupling_mixins[mixin]s can be used to provide the behaviour. ==== @@ -56,7 +56,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): @@ -115,6 +115,6 @@ thn no event will be posted. == Raising events programmatically Normally events are only raised for interactions through the UI. However, events can be raised programmatically either -by calling the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result -of calling the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s +by calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] API directly, or as a result +of calling the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s `titleOf(...)` method. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc index 9901370..82a0d41 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_auditing.adoc @@ -6,11 +6,11 @@ The `auditing()` attribute indicates that if the object is modified, then each of its changed properties should be -submitted to the xref:rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (if one has been configured), or to +submitted to the xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_AuditingService[`AuditingService`] (if one has been configured), or to any The default value for the attribute is `AS_CONFIGURED`, meaning that the -xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.audit.objects` is used to determine the +xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.audit.objects` is used to determine the whether the action is audited: * `all` + http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc index 6c730ef..2fa8299 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_autoCompleteRepository.adoc @@ -14,7 +14,7 @@ For example, this might search for a customer by their name or number. Or it co [TIP] ==== -If you require additional control - for example restricting the returned results based on the object being interacted with - then use the xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method instead. +If you require additional control - for example restricting the returned results based on the object being interacted with - then use the xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method instead. ==== @@ -78,7 +78,7 @@ public class Customers { ---- <1> end-user must enter minimum number of characters to trigger the query -The autocomplete action can also be a regular method, annotated using xref:rgant.adoc#_rgant_Programmatic[`@Programmatic`]: +The autocomplete action can also be a regular method, annotated using xref:../rgant/rgant.adoc#_rgant_Programmatic[`@Programmatic`]: [source,java] ---- @@ -95,5 +95,5 @@ public class Customers { [IMPORTANT] ==== -The method specified must be an action, that is, part of the Isis metamodel. Said another way: it must not be annotated with xref:rgant.adoc#_rgant-Programmatic[`@Programmatic`]. However, it *can* be hidden or placed on a domain service with xref:rgant.adoc#_rgant-DomainService_nature[nature] of `DOMAIN`, such that the action would not be rendered otherwise in the UI. Also, the action cannot be xref:rgant.adoc#_rgant-Action_restrictTo[restricted to] prototyping only. +The method specified must be an action, that is, part of the Isis metamodel. Said another way: it must not be annotated with xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`]. However, it *can* be hidden or placed on a domain service with xref:../rgant/rgant.adoc#_rgant-DomainService_nature[nature] of `DOMAIN`, such that the action would not be rendered otherwise in the UI. Also, the action cannot be xref:../rgant/rgant.adoc#_rgant-Action_restrictTo[restricted to] prototyping only. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_bounded.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_bounded.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_bounded.adoc index 9f2f4f2..40a2c64 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_bounded.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_bounded.adoc @@ -28,7 +28,7 @@ public class Currency { [TIP] ==== -There is nothing to prevent you from using this attribute for regular mutable entities, and indeed this is sometimes worth doing during early prototyping. However, if there is no realistic upper bound to the number of instances of an entity that might be created, generally you should use xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method or the xref:rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`@DomainObject#autoCompleteRepository()`] attribute instead. +There is nothing to prevent you from using this attribute for regular mutable entities, and indeed this is sometimes worth doing during early prototyping. However, if there is no realistic upper bound to the number of instances of an entity that might be created, generally you should use xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method or the xref:../rgant/rgant.adoc#_rgant-DomainObject_autoCompleteRepository[`@DomainObject#autoCompleteRepository()`] attribute instead. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_createdLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_createdLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_createdLifecycleEvent.adoc index 79e2a2c..71355d5 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_createdLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_createdLifecycleEvent.adoc @@ -5,11 +5,11 @@ :_imagesdir: images/ -Whenever a domain object is instantiated or otherwise becomes known to the framework, a "created" lifecycle event is fired. This is typically when the xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[`newTransientInstance()`] is called; +Whenever a domain object is instantiated or otherwise becomes known to the framework, a "created" lifecycle event is fired. This is typically when the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]'s xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_object-creation-api[`newTransientInstance()`] is called; it will also happen if the object is simply instantiated with `new(...)`, and then the container's -xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer_services-api[`injectServicesInto(...)`] method is called. +xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer_services-api[`injectServicesInto(...)`] method is called. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the object just created. The subscriber could then, for example, update the object, eg looking up state from some external datastore. @@ -49,7 +49,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_editing.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_editing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_editing.adoc index fd852eb..82e7be7 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_editing.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_editing.adoc @@ -8,7 +8,7 @@ The `editing()` attribute determines whether a domain object's properties and collections are not editable (are read-only). -The default is `AS_CONFIGURED`, meaning that the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing` is used to determine the whether the object is modifiable: +The default is `AS_CONFIGURED`, meaning that the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.objects.editing` is used to determine the whether the object is modifiable: * `true` + + http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_loadedLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_loadedLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_loadedLifecycleEvent.adoc index f83a82c..4c4536b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_loadedLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_loadedLifecycleEvent.adoc @@ -7,7 +7,7 @@ Whenever a persistent domain object is loaded from the database, a "loaded" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object just loaded. The subscriber could then, for example, update or default values on the object (eg to support on-the-fly migration scenarios). @@ -46,7 +46,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_nature.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_nature.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_nature.adoc index 755bbec..a0e64c9 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_nature.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_nature.adoc @@ -44,7 +44,7 @@ The identity of an inmemory entity is determined solely by the state of entity's + indicates that the domain object is part of the domain layer, and is contributing behaviour to objects of some other type as a mixin (also known as a trait). -Equivalent to annotating with xref:rgant.adoc#_rgant-Mixin[`@Mixin`]. For further discussion on using mixins, see xref:ugbtb.adoc#_ugbtb_decoupling_mixins[mixins] in the user guide. +Equivalent to annotating with xref:../rgant/rgant.adoc#_rgant-Mixin[`@Mixin`]. For further discussion on using mixins, see xref:ugbtb.adoc#_ugbtb_decoupling_mixins[mixins] in the user guide. * `VIEW_MODEL` + @@ -53,7 +53,7 @@ indicates that the domain object is conceptually part of the application layer, The identity of an inmemory entity is determined solely by the state of entity's properties. The framework will automatically recreate the domain object each time it is interacted with. -Those natures that indicate the domain object is an entity (of some sort or another) mean then that the domain object is considered to be part of the domain model layer. As such the domain object's class cannot be annotated with xref:rgant.adoc#_rgant-ViewModel[`@ViewModel`] or implement the xref:rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface. +Those natures that indicate the domain object is an entity (of some sort or another) mean then that the domain object is considered to be part of the domain model layer. As such the domain object's class cannot be annotated with xref:../rgant/rgant.adoc#_rgant-ViewModel[`@ViewModel`] or implement the xref:../rgcms/rgcms.adoc#_rgcms_classes_super_ViewModel[`ViewModel`] interface. [NOTE] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc index 14fa17a..adf3c50 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_objectType.adoc @@ -11,12 +11,12 @@ This value is used internally to generate a string representation of an objects This can appear in several contexts, including: * as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark` - (see xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) + (see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) ** and thus in the "table-of-two-halves" pattern, as per (non-ASF) http://github.com/isisaddons/isis-module-poly[Isis addons' poly] module -* in the serialization of `OidDto` in the xref:rgcms.adoc#_rgcms_schema-cmd[command] and xref:rgcms.adoc#_rgcms_schema-ixn[interaction] schemas +* in the serialization of `OidDto` in the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] and xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction] schemas * in the URLs of the xref:ugvro.adoc#[RestfulObjects viewer] * in the URLs of the xref:ugvw.adoc#[Wicket viewer] (in general and in particular if xref:ugvw.adoc#_ugvw_features_hints-and-copy-url[copying URLs]) -* in XML snapshots generated by the xref:rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`] +* in XML snapshots generated by the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_XmlSnapshotService[`XmlSnapshotService`] @@ -39,9 +39,9 @@ public class Order { The rules of precedence are: -1. xref:rgant.adoc#_rgant_Discriminator[`@Discriminator`] -2. `@DomainObject#objectType`, or xref:rgant.adoc#_rgant_aaa_deprecated[`@ObjectType`] (deprecated) -3. xref:rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. + +1. xref:../rgant/rgant.adoc#_rgant_Discriminator[`@Discriminator`] +2. `@DomainObject#objectType`, or xref:../rgant/rgant.adoc#_rgant_aaa_deprecated[`@ObjectType`] (deprecated) +3. xref:../rgant/rgant.adoc#_rgant_PersistenceCapable[`@PersistenceCapable`], if at least the `schema` attribute is defined. + + If both `schema` and `table` are defined, then the value is "`schema.table`". If only `schema` is defined, then the value is "`schema.className`". http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistedLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistedLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistedLifecycleEvent.adoc index cf34e34..a948b48 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistedLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistedLifecycleEvent.adoc @@ -8,7 +8,7 @@ Whenever a (just created, still transient) domain object has been saved (INSERTed in)to the database, a "persisted" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object. The subscriber could then, for example, maintain an external datastore. @@ -52,7 +52,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistingLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistingLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistingLifecycleEvent.adoc index ae1f54a..20a5194 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistingLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_persistingLifecycleEvent.adoc @@ -8,7 +8,7 @@ Whenever a (just created, still transient) domain object is about to be saved (INSERTed in)to the database, a "persisting" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object. The subscriber could then, for example, update the object, or it could use it maintain an external datastore. One possible application is to maintain a full-text search database using link:https://lucene.apache.org/[Apache Lucene] or similar. @@ -17,7 +17,7 @@ link:https://lucene.apache.org/[Apache Lucene] or similar. ==== Another use case is to maintain "last updated by"/"last updated at" properties. While you can roll your own, note that the framework provides built-in support for this use case through the -xref:rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. +xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. ==== By default the event raised is `ObjectPersistingEvent.Default`. For example: @@ -55,7 +55,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc index 173f5d5..b4263a4 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_publishing.adoc @@ -7,15 +7,15 @@ The `publishing()` attribute determines whether and how a modified object instance is published via the registered -implementation of a xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or -xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also supported -for xref:rgant.adoc#_rgant-Action_publishing[actions], where it controls whether action invocations are published as -events, and for xref:rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls whether +implementation of a xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`]) or +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`]. This attribute is also supported +for xref:../rgant/rgant.adoc#_rgant-Action_publishing[actions], where it controls whether action invocations are published as +events, and for xref:../rgant/rgant.adoc#_rgant_Property_publishing[`@Property#publishing()`], where it controls whether property edits are published as events. A common use case is to notify external "downstream" systems of changes in the state of the Isis application. -The default value for the attribute is `AS_CONFIGURED`, meaning that the xref:rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.objects` is used to determine the whether the action is published: +The default value for the attribute is `AS_CONFIGURED`, meaning that the xref:../rgcfg/rgcfg.adoc#_rgcfg_configuring-core[configuration property] `isis.services.publish.objects` is used to determine the whether the action is published: * `all` + + @@ -58,6 +58,6 @@ this should avoid the necessity to query back for additional information. [WARNING] ==== Be aware that this attribute is only honoured by the (deprecated) -xref:rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`], so should itself be considered as deprecated. It -is ignored by the replacement xref:rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`], +xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublishingService[`PublishingService`], so should itself be considered as deprecated. It +is ignored by the replacement xref:../rgsvc/rgsvc.adoc#_rgsvc_spi_PublisherService[`PublisherService`], ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_removingLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_removingLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_removingLifecycleEvent.adoc index 190725a..fa7e0f2 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_removingLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_removingLifecycleEvent.adoc @@ -8,7 +8,7 @@ Whenever a (persistent) domain object is about to be removed (DELETEd) from the database, a "removing" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object. The subscriber could then, for example, could use it maintain an external datastore. One possible application is to maintain a full-text search database using link:https://lucene.apache.org/[Apache Lucene] or similar. @@ -17,7 +17,7 @@ using link:https://lucene.apache.org/[Apache Lucene] or similar. ==== Another use case is to maintain "last updated by"/"last updated at" properties. While you can roll your own, note that the framework provides built-in support for this use case through the -xref:rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. +xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. ==== By default the event raised is `ObjectRemovingEvent.Default`. For example: @@ -55,7 +55,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatedLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatedLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatedLifecycleEvent.adoc index da3845b..6996a45 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatedLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatedLifecycleEvent.adoc @@ -8,7 +8,7 @@ Whenever a (persistent) domain object has been modified and has been updated in the database, an "updated" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object. [WARNING] @@ -51,7 +51,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatingLifecycleEvent.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatingLifecycleEvent.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatingLifecycleEvent.adoc index af5d2fb..d824947 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatingLifecycleEvent.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainObject_updatingLifecycleEvent.adoc @@ -8,7 +8,7 @@ Whenever a (persistent) domain object has been modified and is about to be updated to the database, an "updating" lifecycle event is fired. -Subscribers subscribe through the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can +Subscribers subscribe through the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and can use the event to obtain a reference to the domain object. The subscriber could then, for example, update the object, or it could use it maintain an external datastore. One possible application is to maintain a full-text search database using link:https://lucene.apache.org/[Apache Lucene] or similar. @@ -17,7 +17,7 @@ using link:https://lucene.apache.org/[Apache Lucene] or similar. ==== Another use case is to maintain "last updated by"/"last updated at" properties. While you can roll your own, note that the framework provides built-in support for this use case through the -xref:rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. +xref:../rgcms/rgcms.adoc#_rgcms_classes_roles_Timestampable[`Timestampable`] role interface. ==== By default the event raised is `ObjectUpdatingEvent.Default`. For example: @@ -55,7 +55,7 @@ The benefit is that subscribers can be more targeted as to the events that they == Subscribers Subscribers (which must be domain services) subscribe using either the link:https://github.com/google/guava[Guava] API -or (if the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) +or (if the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] has been appropriately configured) using the link:http://www.axonframework.org/[Axon Framework] API. The examples below use the Guava API. Subscribers can be either coarse-grained (if they subscribe to the top-level event type): http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc index 1b00e29..a1e1d18 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService.adoc @@ -22,26 +22,26 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-DomainService_nature[`nature()`] +|xref:../rgant/rgant.adoc#_rgant-DomainService_nature[`nature()`] |`VIEW`, `VIEW_MENU_ONLY`, `VIEW_CONTRIBUTIONS_ONLY`, `VIEW_REST_ONLY`, `DOMAIN` (`VIEW`) |the nature of this service: providing actions for menus, or as contributed actions, or for the xref:ugvro.adoc#[RestfulObjects REST API], or neither -|xref:rgant.adoc#_rgant-DomainService_objectType[`objectType()`] +|xref:../rgant/rgant.adoc#_rgant-DomainService_objectType[`objectType()`] | -|equivalent to xref:rgant.adoc#_rgant_DomainObject_objectType[`@DomainObject#objectType()`], specifies the objectType of the service. +|equivalent to xref:../rgant/rgant.adoc#_rgant_DomainObject_objectType[`@DomainObject#objectType()`], specifies the objectType of the service. The instanceId for services is always "1". -|xref:rgant.adoc#_rgant-DomainService_repositoryFor[`repositoryFor()`] +|xref:../rgant/rgant.adoc#_rgant-DomainService_repositoryFor[`repositoryFor()`] | |if this domain service acts as a repository for an entity type, specify that entity type. This is used to determine an icon to use for the service (eg as shown in action prompts). |`menuOrder()` | -|Deprecated in 1.8.0; use instead xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] +|Deprecated in 1.8.0; use instead xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] |=== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout.adoc index 90e54de..10674c7 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout.adoc @@ -25,17 +25,17 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-DomainServiceLayout_menuBar[`menuBar()`] +|xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuBar[`menuBar()`] |`PRIMARY`, `SECONDARY`, `TERTIARY` (`PRIMARY`). |the menubar in which the menu that holds this service's actions should reside. -|xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] +|xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] | |the order of the service's menu with respect to other service's. -|xref:rgant.adoc#_rgant-DomainServiceLayout_named[`named()`] +|xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[`named()`] |string, eg "Customers" |name of this class (overriding the name derived from its name in code) http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuBar.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuBar.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuBar.adoc index 1f0b649..f300e81 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuBar.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuBar.adoc @@ -33,7 +33,7 @@ Domain services placed on the `TERTIARY` appear in the menu bar associated with image::{_imagesdir}reference-annotations/DomainServiceLayout/menuBar-tertiary.png[width="720px",link="{_imagesdir}reference-annotations/DomainServiceLayout/menuBar-tertiary.png"] -The grouping of multiple domain services actions within a single drop-down is managed by the xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute. +The grouping of multiple domain services actions within a single drop-down is managed by the xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`@DomainServiceLayout#menuOrder()`] attribute. [NOTE] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuOrder.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuOrder.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuOrder.adoc index ee56c12..95fc52b 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuOrder.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_menuOrder.adoc @@ -11,8 +11,8 @@ The `menuOrder()` attribute determines the ordering of a domain service's action The algorithm works as follows: -* first, the xref:rgant.adoc#_rgant-DomainServiceLayout_menuBar[`menuBar()`] determines which of the three menu bars the service's actions should be rendered -* then, the domain service's top-level name (typically explicitly specified using xref:rgant.adoc#_rgant-DomainServiceLayout_named[`named()`]) is used to determine the top-level menu item to be rendered on the menu bar +* first, the xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuBar[`menuBar()`] determines which of the three menu bars the service's actions should be rendered +* then, the domain service's top-level name (typically explicitly specified using xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_named[`named()`]) is used to determine the top-level menu item to be rendered on the menu bar * finally, if there is more than domain service that has the same name, then the `menuOrder` attribute is used to order those actions on the menu item drop-down. For example, the screenshot below shows the "prototyping" menu from the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc index 9ee9806..030b5b4 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainServiceLayout_named.adoc @@ -5,12 +5,12 @@ :_imagesdir: images/ -The `named()` attribute explicitly specifies the domain service's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:rgant.adoc#_rgant-ActionLayout_named[actions], xref:rgant.adoc#_rgant-CollectionLayout_named[collections], xref:rgant.adoc#_rgant-PropertyLayout_named[properties], xref:rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:rgant.adoc#_rgant-DomainObjectLayout_named[domain objects] and xref:rgant.adoc#_rgant-ViewModelLayout_named[view models]. +The `named()` attribute explicitly specifies the domain service's name, overriding the name that would normally be inferred from the Java source code. This attribute can also be specified for xref:../rgant/rgant.adoc#_rgant-ActionLayout_named[actions], xref:../rgant/rgant.adoc#_rgant-CollectionLayout_named[collections], xref:../rgant/rgant.adoc#_rgant-PropertyLayout_named[properties], xref:../rgant/rgant.adoc#_rgant-ParameterLayout_named[parameters], xref:../rgant/rgant.adoc#_rgant-DomainObjectLayout_named[domain objects] and xref:../rgant/rgant.adoc#_rgant-ViewModelLayout_named[view models]. [TIP] ==== -The value of this attribute also has an important role to play in the positioning of the domain service's actions relative to the actions of other domain services. See xref:rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] for a full discussion with examples. +The value of this attribute also has an important role to play in the positioning of the domain service's actions relative to the actions of other domain services. See xref:../rgant/rgant.adoc#_rgant-DomainServiceLayout_menuOrder[`menuOrder()`] for a full discussion with examples. ==== For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_nature.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_nature.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_nature.adoc index bedafaf..d53ca76 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_nature.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_nature.adoc @@ -21,7 +21,7 @@ The service's actions appear on menus and in the REST API, but are not contribut + The service's actions are intended only to be used as contributed actions/associations to domain objects and view models. + + -The related xref:rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`] determines whether any given (1-arg) action is contributed as an association rather than an action. +The related xref:../rgant/rgant.adoc#_rgant-ActionLayout_contributedAs[`@ActionLayout#contributedAs()`] determines whether any given (1-arg) action is contributed as an association rather than an action. * `VIEW_REST_ONLY` + + @@ -65,7 +65,7 @@ public class LoanRepository { // <1> } ---- <1> `Repository` as a suffix for a domain-layer service -<2> methods on `DOMAIN` services are often xref:rgant.adoc#_rgant-Programmatic[`@Programmatic`]; they will never be exposed in the UI, so there's little point in including them in Apache Isis' metamodel +<2> methods on `DOMAIN` services are often xref:../rgant/rgant.adoc#_rgant-Programmatic[`@Programmatic`]; they will never be exposed in the UI, so there's little point in including them in Apache Isis' metamodel http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_objectType.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_objectType.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_objectType.adoc index 767c8a7..7ceca4d 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_objectType.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_objectType.adoc @@ -11,8 +11,8 @@ This value is used internally to generate a string representation of an service This can appear in several contexts, including: * as the value of `Bookmark#getObjectType()` and in the `toString()` value of `Bookmark` - (see xref:rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) -* in the serialization of `OidDto` in the xref:rgcms.adoc#_rgcms_schema-cmd[command] and xref:rgcms.adoc#_rgcms_schema-ixn[interaction] schemas + (see xref:../rgsvc/rgsvc.adoc#_rgsvc_api_BookmarkService[`BookmarkService`]) +* in the serialization of `OidDto` in the xref:../rgcms/rgcms.adoc#_rgcms_schema-cmd[command] and xref:../rgcms/rgcms.adoc#_rgcms_schema-ixn[interaction] schemas * in the URLs of the xref:ugvro.adoc#[RestfulObjects viewer] * in the URLs of the xref:ugvw.adoc#[Wicket viewer] (specifically, for bookmarked actions) @@ -39,7 +39,7 @@ public class OrderMenu { The rules of precedence are: 1. `@DomainService#objectType` -2. xref:rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`] +2. xref:../rgcms/rgcms.adoc#_rgcms_methods_reserved_getId[`getId()`] 3. The fully qualified class name. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_repositoryFor.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_repositoryFor.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_repositoryFor.adoc index 4656a01..6ac3782 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_repositoryFor.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-DomainService_repositoryFor.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `repositoryFor()` attribute is intended for domain services (probably with a xref:rgant.adoc#_rgant-DomainService_nature[`nature=DOMAIN`]) that are intended to act as repositories for domain entities. +The `repositoryFor()` attribute is intended for domain services (probably with a xref:../rgant/rgant.adoc#_rgant-DomainService_nature[`nature=DOMAIN`]) that are intended to act as repositories for domain entities. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Inject.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Inject.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Inject.adoc index 2aae64a..6ba109e 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Inject.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Inject.adoc @@ -10,7 +10,7 @@ Apache Isis automatically injects domain services into other domain services and [NOTE] ==== -One omission: Apache Isis (currently) does not inject services into `o.a.i.applib.spec.Specification` instances (as used by xref:rgant.adoc#_rgant-Property_mustSatisfy[`@Property#mustSatisfy()`] and xref:rgant.adoc#_rgant-Parameter_mustSatisfy[`@Parameter#mustSatisfy()`] annotations. +One omission: Apache Isis (currently) does not inject services into `o.a.i.applib.spec.Specification` instances (as used by xref:../rgant/rgant.adoc#_rgant-Property_mustSatisfy[`@Property#mustSatisfy()`] and xref:../rgant/rgant.adoc#_rgant-Parameter_mustSatisfy[`@Parameter#mustSatisfy()`] annotations. ==== Isis supports several syntaxes for injecting domain services. The simplest uses the `@javax.inject.Inject` annotation on the field, as defined in link:https://jcp.org/en/jsr/detail?id=330[JSR-330]. @@ -27,7 +27,7 @@ public class Customer { OrderRepository orders; // <2> } ---- -<1> an alternative implementation would be to implement `findRecentOrders()` as a xref:ugfun.adoc#_ugfun_how-tos_contributed-members[contributed action]. +<1> an alternative implementation would be to implement `findRecentOrders()` as a xref:../ugfun/ugfun.adoc#_ugfun_how-tos_contributed-members[contributed action]. <2> we recommend default (rather than `private`) visibility so that unit tests can easily mock out the service @@ -94,7 +94,7 @@ public class Customer { [NOTE] ==== -An alternative and almost equivalent design would be to publish an event using the xref:rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and implement the domain services as subscribers to +An alternative and almost equivalent design would be to publish an event using the xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`] and implement the domain services as subscribers to the event. This alternative design is used in the (non-ASF) http://github.com/isisaddons/isis-module-poly[Isis addons' poly] module, for example. ==== @@ -114,7 +114,7 @@ Customer cust = container.newTransientInstance(Customer.class); <1> // initialize state of "cust" container.persist(cust); ---- -<1> where `container` is an instance of xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. +<1> where `container` is an instance of xref:../rgsvc/rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]. View models are created similarly: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberGroupLayout.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberGroupLayout.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberGroupLayout.adoc index 7ec4935..f9400a5 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberGroupLayout.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberGroupLayout.adoc @@ -6,10 +6,10 @@ -The `@MemberGroupLayout` annotation specifies how an object's properties and collections are grouped together into columns, also specifying the relative positioning of those columns. It works in conjunction with the xref:rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. +The `@MemberGroupLayout` annotation specifies how an object's properties and collections are grouped together into columns, also specifying the relative positioning of those columns. It works in conjunction with the xref:../rgant/rgant.adoc#_rgant-MemberOrder[`@MemberOrder`] annotation. -The `@MemberOrder` annotation is used to specify the relative order of domain object members, that is: properties, collections and actions. It works in conjunction with the xref:rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] annotation. +The `@MemberOrder` annotation is used to specify the relative order of domain object members, that is: properties, collections and actions. It works in conjunction with the xref:../rgant/rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] annotation. The annotation defines two attributes, `name()` and `sequence()`. Broadly speaking the `name()` attribute is used to group or associate members together, while the `sequence()` attribute orders members once they have been grouped. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberOrder.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberOrder.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberOrder.adoc index 1aca506..c813ea4 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberOrder.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MemberOrder.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `@MemberOrder` annotation is used to specify the relative order of domain object members, that is: properties, collections and actions. It works in conjunction with the xref:rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] annotation. +The `@MemberOrder` annotation is used to specify the relative order of domain object members, that is: properties, collections and actions. It works in conjunction with the xref:../rgant/rgant.adoc#_rgant-MemberGroupLayout[`@MemberGroupLayout`] annotation. The annotation defines four attributes: @@ -27,8 +27,8 @@ As this is an important topic, there is a xref:ugvw.adoc#_ugvw_layout[separate c [TIP] ==== -The annotation is one of a handful (others including xref:rgant.adoc#_rgant-Collection[`@Collection`], xref:rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:rgant.adoc#_rgant-Property[`@Property`]) - and xref:rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] that can also be applied to the field, rather than the getter method. This is specifically +The annotation is one of a handful (others including xref:../rgant/rgant.adoc#_rgant-Collection[`@Collection`], xref:../rgant/rgant.adoc#_rgant-CollectionLayout[`@CollectionLayout`], xref:../rgant/rgant.adoc#_rgant-Property[`@Property`]) + and xref:../rgant/rgant.adoc#_rgant-PropertyLayout[`@PropertyLayout`] that can also be applied to the field, rather than the getter method. This is specifically so that boilerplate-busting tools such as link:https://projectlombok.org/[Project Lombok] can be used. ==== http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MinLength.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MinLength.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MinLength.adoc index 87fad10..d38ad65 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MinLength.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-MinLength.adoc @@ -5,7 +5,7 @@ :_imagesdir: images/ -The `@MinLength` annotation is used to specify the minimum number of characters in a search of an xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method. +The `@MinLength` annotation is used to specify the minimum number of characters in a search of an xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method. For example: http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Mixin.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Mixin.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Mixin.adoc index 587868a..92b1acf 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Mixin.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Mixin.adoc @@ -25,7 +25,7 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-Mixin_method[`method()`] +|xref:../rgant/rgant.adoc#_rgant-Mixin_method[`method()`] |Method name within the mixin |How to recognize the "reserved" method name, meaning that the mixin's own name will be inferred from the mixin type. Typical examples are "exec", "execute", "invoke", "apply" and so on. @@ -34,7 +34,7 @@ The default "reserved" method name is `$$`. |=== An alternative and equivalent approach is to use the -xref:rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature()`] annotation with a nature of `MIXIN`. +xref:../rgant/rgant.adoc#_rgant-DomainObject_nature[`@DomainObject#nature()`] annotation with a nature of `MIXIN`. include::_rgant-Mixin_method.adoc[leveloffset=+1] http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc index 1186553..51c4cb0 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Nullable.adoc @@ -34,20 +34,20 @@ public Customer updateName(@javax.annotation.Nullable final String name) { ---- Apache Isis does provide several other ways to specify optionality: using the -xref:rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] / -xref:rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`] annotation. For properties, the optionality -can also be inferred from the xref:rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`] attribute. +xref:../rgant/rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] / +xref:../rgant/rgant.adoc#_rgant_Parameter_optionality[`@Parameter#optionality()`] annotation. For properties, the optionality +can also be inferred from the xref:../rgant/rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`] attribute. [TIP] ==== See the -xref:rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] documentation for a much fuller discussion on +xref:../rgant/rgant.adoc#_rgant_Property_optionality[`@Property#optionality()`] documentation for a much fuller discussion on the relationship between using the Apache Isis annotations vs -xref:rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`]. +xref:../rgant/rgant.adoc#_rgant_Column_allowsNull[`@Column#allowsNull()`]. ==== If more than one method is specified then the framework will validate that there are no incompatibilities (and fail to -boot otherwise). This can also be verified using the xref:rgmvn.adoc#_rgmvn_validate[validate goal] of the Apache +boot otherwise). This can also be verified using the xref:../rgmvn/rgmvn.adoc#_rgmvn_validate[validate goal] of the Apache Isis Maven plugin. http://git-wip-us.apache.org/repos/asf/isis/blob/252c2f8e/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc ---------------------------------------------------------------------- diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc index 539ca23..9f2d280 100644 --- a/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc +++ b/adocs/documentation/src/main/asciidoc/guides/rgant/_rgant-Parameter.adoc @@ -18,38 +18,38 @@ The table below summarizes the annotation's attributes. | Description -|xref:rgant.adoc#_rgant-Parameter_fileAccept[`fileAccept()`] +|xref:../rgant/rgant.adoc#_rgant-Parameter_fileAccept[`fileAccept()`] |Media type or file extension -|Hints the file type to be uploaded for xref:rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] - or xref:rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. + +|Hints the file type to be uploaded for xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Blob[`Blob`] + or xref:../rgcms/rgcms.adoc#_rgcms_classes_value-types_Clob[`Clob`]. + + Note that this does not prevent the user from uploading some other file type; rather it merely defaults the file type in the file open dialog. -|xref:rgant.adoc#_rgant-Parameter_maxLength[`maxLength()`] +|xref:../rgant/rgant.adoc#_rgant-Parameter_maxLength[`maxLength()`] |Positive integer |maximum number of characters for string parameters; ignored otherwise |`minLength()` |Positive integer -|Deprecated; use xref:rgant.adoc#_rgant_minLength[`@MinLength`] instead. + +|Deprecated; use xref:../rgant/rgant.adoc#_rgant_minLength[`@MinLength`] instead. + -Can be used to specify the minimum length for xref:rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method; but because this _is a_ supporting method rather than the action method itself, we now feel it is misleading to use the `@Parameter` annotation in this situation. +Can be used to specify the minimum length for xref:../rgcms/rgcms.adoc#_rgcms_methods_prefixes_autoComplete[`autoComplete...()`] supporting method; but because this _is a_ supporting method rather than the action method itself, we now feel it is misleading to use the `@Parameter` annotation in this situation. -|xref:rgant.adoc#_rgant-Parameter_mustSatisfy[`mustSatisfy()`] +|xref:../rgant/rgant.adoc#_rgant-Parameter_mustSatisfy[`mustSatisfy()`] |implementation of `o.a.i.applib.spec.Specification` |allows arbitrary validation to be applied -|xref:rgant.adoc#_rgant-Parameter_optionality[`optionality()`] +|xref:../rgant/rgant.adoc#_rgant-Parameter_optionality[`optionality()`] |`MANDATORY`, `OPTIONAL` (`MANDATORY`) |specifies a parameter is optional rather than mandatory -|xref:rgant.adoc#_rgant-Parameter_regexPattern[regexPattern()] +|xref:../rgant/rgant.adoc#_rgant-Parameter_regexPattern[regexPattern()] |regular expression |validates the contents of a string parameter against the regular expression pattern
