[27/58] [abbrv] isis git commit: more on ugfun.adoc - identifiers, programming model for services etc

2017-04-20 Thread danhaywood 
more on ugfun.adoc - identifiers, programming model for services etc


Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/2ca2ea18
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/2ca2ea18
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/2ca2ea18

Branch: refs/heads/master
Commit: 2ca2ea184da8d9ef1a65e22139d0a2030290a2c2
Parents: 2f2714c
Author: Dan Haywood 
Authored: Mon Apr 17 14:51:19 2017 +0100
Committer: Dan Haywood 
Committed: Thu Apr 20 09:09:30 2017 +0100

--
 .../guides/ugfun/_ugfun_building-blocks.adoc|   4 +-
 .../ugfun/_ugfun_building-blocks_events.adoc|  61 +-
 ...un_building-blocks_events_domain-events.adoc |  40 
 ...building-blocks_events_lifecycle-events.adoc |  32 +++
 ..._ugfun_building-blocks_events_ui-events.adoc |  28 +++
 .../_ugfun_building-blocks_identifiers.adoc |   4 +-
 ...lding-blocks_identifiers_title-and-icon.adoc |  24 ++-
 .../ugfun/_ugfun_building-blocks_modules.adoc   |   9 +
 ...ugfun_programming-model_domain-entities.adoc | 129 
 ...ugfun_programming-model_domain-services.adoc | 209 +--
 ...gfun_programming-model_view-models_jaxb.adoc |  10 +
 ..._programming-model_view-models_non-jaxb.adoc |  12 ++
 ..._ugfun_ui-hints_object-titles-and-icons.adoc |  12 +-
 13 files changed, 350 insertions(+), 224 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/isis/blob/2ca2ea18/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
--
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
index 8c61796..fe81aa7 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
@@ -16,8 +16,6 @@ 
include::_ugfun_building-blocks_object-members.adoc[leveloffset=+1]
 
 include::_ugfun_building-blocks_events.adoc[leveloffset=+1]
 
-include::_ugfun_building-blocks_identifiers.adoc[leveloffset=+1]
-
-nclude::_ugfun_building-blocks_modules.adoc[leveloffset=+1]
+include::_ugfun_building-blocks_modules.adoc[leveloffset=+1]
 
 

http://git-wip-us.apache.org/repos/asf/isis/blob/2ca2ea18/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
--
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
index ded8c28..1746b40 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
@@ -11,7 +11,7 @@ These events enable other domain services (possibly in other 
modules) to influen
 [TIP]
 
 It is also possible to simulate the rendering of a domain object by way of the 
xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`].
-This
+This allows business rules to be enforced for programmatic interactions 
between objects.
 
 
 To receive the events, the domain service should subscribe to the 
xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`], and 
implement an appropriately annotated method to receive the events.
@@ -20,60 +20,7 @@ The framework has several categories of events: domain 
events, UI events and lif
 These are explored in the sections below.
 
 
-
-== Domain Events
-Domain events are fired for each object member (property, collection or 
action).
-
-By default, rendering a property causes a `PropertyDomainEvent` to be fired, 
though the 
xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`] 
attribute allows a custom subclass to be specified if necessary.
-Similarly, rendering a collection causes a `CollectionDomainEvent` to be 
fired, and rendering an action causes an `ActionDomainEvent` to be fired.
-
-In fact, each event can be fired up to five times, with the event's 
`getEventPhase()` method indicating to the subscriber the phase:
-
-* *hide* phase allows the subscriber to hide the member
-
-* *disable* phase allows the subscriber to disable the member. +
-
-For a property this makes it read-only; for an action this makes it "greyed 
out".
-(Collections are implicitly read-only).
-
-* *validate* phase allows the subscriber to validate the proposed change.
-
-For a property this means validating the proposed new value of the property; 
for an action this means validating the action parameter arguments.
-For

[27/58] [abbrv] isis git commit: more on ugfun.adoc - identifiers, programming model for services etc

2017-04-20 Thread danhaywood 
more on ugfun.adoc - identifiers, programming model for services etc


Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/2ca2ea18
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/2ca2ea18
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/2ca2ea18

Branch: refs/heads/wip
Commit: 2ca2ea184da8d9ef1a65e22139d0a2030290a2c2
Parents: 2f2714c
Author: Dan Haywood 
Authored: Mon Apr 17 14:51:19 2017 +0100
Committer: Dan Haywood 
Committed: Thu Apr 20 09:09:30 2017 +0100

--
 .../guides/ugfun/_ugfun_building-blocks.adoc|   4 +-
 .../ugfun/_ugfun_building-blocks_events.adoc|  61 +-
 ...un_building-blocks_events_domain-events.adoc |  40 
 ...building-blocks_events_lifecycle-events.adoc |  32 +++
 ..._ugfun_building-blocks_events_ui-events.adoc |  28 +++
 .../_ugfun_building-blocks_identifiers.adoc |   4 +-
 ...lding-blocks_identifiers_title-and-icon.adoc |  24 ++-
 .../ugfun/_ugfun_building-blocks_modules.adoc   |   9 +
 ...ugfun_programming-model_domain-entities.adoc | 129 
 ...ugfun_programming-model_domain-services.adoc | 209 +--
 ...gfun_programming-model_view-models_jaxb.adoc |  10 +
 ..._programming-model_view-models_non-jaxb.adoc |  12 ++
 ..._ugfun_ui-hints_object-titles-and-icons.adoc |  12 +-
 13 files changed, 350 insertions(+), 224 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/isis/blob/2ca2ea18/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
--
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
index 8c61796..fe81aa7 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks.adoc
@@ -16,8 +16,6 @@ 
include::_ugfun_building-blocks_object-members.adoc[leveloffset=+1]
 
 include::_ugfun_building-blocks_events.adoc[leveloffset=+1]
 
-include::_ugfun_building-blocks_identifiers.adoc[leveloffset=+1]
-
-nclude::_ugfun_building-blocks_modules.adoc[leveloffset=+1]
+include::_ugfun_building-blocks_modules.adoc[leveloffset=+1]
 
 

http://git-wip-us.apache.org/repos/asf/isis/blob/2ca2ea18/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
--
diff --git 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
index ded8c28..1746b40 100644
--- 
a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
+++ 
b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_building-blocks_events.adoc
@@ -11,7 +11,7 @@ These events enable other domain services (possibly in other 
modules) to influen
 [TIP]
 
 It is also possible to simulate the rendering of a domain object by way of the 
xref:../rgsvc/rgsvc.adoc#_rgsvc_api_WrapperFactory[`WrapperFactory`].
-This
+This allows business rules to be enforced for programmatic interactions 
between objects.
 
 
 To receive the events, the domain service should subscribe to the 
xref:../rgsvc/rgsvc.adoc#_rgsvc_api_EventBusService[`EventBusService`], and 
implement an appropriately annotated method to receive the events.
@@ -20,60 +20,7 @@ The framework has several categories of events: domain 
events, UI events and lif
 These are explored in the sections below.
 
 
-
-== Domain Events
-Domain events are fired for each object member (property, collection or 
action).
-
-By default, rendering a property causes a `PropertyDomainEvent` to be fired, 
though the 
xref:../rgant/rgant.adoc#_rgant_Property_domainEvent[`@Property#domainEvent()`] 
attribute allows a custom subclass to be specified if necessary.
-Similarly, rendering a collection causes a `CollectionDomainEvent` to be 
fired, and rendering an action causes an `ActionDomainEvent` to be fired.
-
-In fact, each event can be fired up to five times, with the event's 
`getEventPhase()` method indicating to the subscriber the phase:
-
-* *hide* phase allows the subscriber to hide the member
-
-* *disable* phase allows the subscriber to disable the member. +
-
-For a property this makes it read-only; for an action this makes it "greyed 
out".
-(Collections are implicitly read-only).
-
-* *validate* phase allows the subscriber to validate the proposed change.
-
-For a property this means validating the proposed new value of the property; 
for an action this means validating the action parameter arguments.
-For example,