You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2013/05/23 11:55:22 UTC
svn commit: r1485636 - in /isis/site/trunk/content/applib-guide: ./
domain-services/ how-tos/ reference/ reference/recognized-annotations/
supporting-features/ value-types/
Author: danhaywood
Date: Thu May 23 09:55:22 2013
New Revision: 1485636
URL: http://svn.apache.org/r1485636
Log:
more on the applib markdown
Added:
isis/site/trunk/content/applib-guide/about.md
- copied, changed from r1485630, isis/site/trunk/content/applib-guide/applib-guide-intro.md
isis/site/trunk/content/applib-guide/domain-services/about.md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/domain-services/000-about.md
isis/site/trunk/content/applib-guide/how-tos/about.md
- copied, changed from r1485623, isis/site/trunk/content/applib-guide/how-tos/000-about.md
isis/site/trunk/content/applib-guide/reference/about.md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/Idempotent-(deprecated).md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/reference/recognized-annotations/Idempotent (deprecated).md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/Ignore-(deprecated).md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/reference/recognized-annotations/Ignore (deprecated).md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/QueryOnly-(deprecated).md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/reference/recognized-annotations/QueryOnly.md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/about.md
- copied, changed from r1485623, isis/site/trunk/content/applib-guide/reference/recognized-annotations/000-about.md
isis/site/trunk/content/applib-guide/supporting-features/about.md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/supporting-features/000-about.md
isis/site/trunk/content/applib-guide/value-types/010-Built-in-Value-Types.md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/value-types/020-Built-in-Value-Types.md
isis/site/trunk/content/applib-guide/value-types/020-Custom-Value-Types.md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/value-types/030-Custom-Value-Types.md
isis/site/trunk/content/applib-guide/value-types/030-Third-party-Value-Types.md
- copied unchanged from r1485623, isis/site/trunk/content/applib-guide/value-types/04-Third-party-Value-Types.md
isis/site/trunk/content/applib-guide/value-types/about.md
- copied, changed from r1485623, isis/site/trunk/content/applib-guide/value-types/000-about.md
Removed:
isis/site/trunk/content/applib-guide/applib-guide-intro.md
isis/site/trunk/content/applib-guide/domain-services/000-about.md
isis/site/trunk/content/applib-guide/how-tos/000-about.md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/000-about.md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/Idempotent (deprecated).md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/Ignore (deprecated).md
isis/site/trunk/content/applib-guide/reference/recognized-annotations/QueryOnly.md
isis/site/trunk/content/applib-guide/supporting-features/000-about.md
isis/site/trunk/content/applib-guide/value-types/000-about.md
isis/site/trunk/content/applib-guide/value-types/020-Built-in-Value-Types.md
isis/site/trunk/content/applib-guide/value-types/030-Custom-Value-Types.md
isis/site/trunk/content/applib-guide/value-types/04-Third-party-Value-Types.md
Copied: isis/site/trunk/content/applib-guide/about.md (from r1485630, isis/site/trunk/content/applib-guide/applib-guide-intro.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/applib-guide/about.md?p2=isis/site/trunk/content/applib-guide/about.md&p1=isis/site/trunk/content/applib-guide/applib-guide-intro.md&r1=1485630&r2=1485636&rev=1485636&view=diff
==============================================================================
--- isis/site/trunk/content/applib-guide/applib-guide-intro.md (original)
+++ isis/site/trunk/content/applib-guide/about.md Thu May 23 09:55:22 2013
@@ -8,21 +8,21 @@ This guide to the programming model brea
##How-tos
-* [How-to write Domain Entities](./how-tos/000-about.html)
+* [How-to write Domain Entities](./how-tos/about.html)
-* [Domain Services, Repositories and Factories](./domain-services/000-about.html)
+* [Domain Services, Repositories and Factories](./domain-services/about.html)
-* [Value Types](./value-types/000-about.html)
+* [Value Types](./value-types/about.html)
##Supporting Features
-* [Clock, Fixtures, etc](./supporting-features/000-about.html)
+* [Clock, Fixtures, etc](./supporting-features/about.html)
##Reference
* [Recognized Methods and Prefixes](./reference/Recognized-Methods-and-Prefixes.html)
-* [Recognized Annotations](./reference/recognized-annotations/000-about.html)
+* [Recognized Annotations](./reference/recognized-annotations/about.html)
* [DomainObjectContainer interface](./reference/DomainObjectContainer.html)
Copied: isis/site/trunk/content/applib-guide/how-tos/about.md (from r1485623, isis/site/trunk/content/applib-guide/how-tos/000-about.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/applib-guide/how-tos/about.md?p2=isis/site/trunk/content/applib-guide/how-tos/about.md&p1=isis/site/trunk/content/applib-guide/how-tos/000-about.md&r1=1485623&r2=1485636&rev=1485636&view=diff
==============================================================================
--- isis/site/trunk/content/applib-guide/how-tos/000-about.md (original)
+++ isis/site/trunk/content/applib-guide/how-tos/about.md Thu May 23 09:55:22 2013
@@ -1,11 +1,6 @@
title: How-tos
-How to write a basic Domain Entity or Service
-=============================================
-
-> How-to write a basic domain entity or service, specifying its
-> properties, collections and actions, and using some of the most
-> commonly-used additional semantics.
+##How to write a basic Domain Entity or Service
Domain entities are instances of some class, usually (the vast majority)
being persisted. Domain services are singletons that act typically act
@@ -17,11 +12,11 @@ and services have behaviour, in the form
* [How to have a domain service be a POJO](./how-to-01-020-How-to-have-a-domain-service-be-a-POJO.html)
-* [How to add a property to a domain entity](./how-to-01-030-How-to-add a property to a domain entity.html)
+* [How to add a property to a domain entity](./how-to-01-030-How-to-add-a-property-to-a-domain-entity.html)
* [How to specify a title for a domain entity](./how-to-01-040-How-to-specify-a-title-for-a-domain-entity.html)
-* [How to add a collection to a domain entity](./how-to-01-050-How-to-add-a-collection-to-a-domain entity.html)
+* [How to add a collection to a domain entity](./how-to-01-050-How-to-add-a-collection-to-a-domain-entity.html)
* [How to add an action to a domain entity or service](./how-to-01-060-How-to-add-an-action-to-a-domain-entity-or-service.html)
@@ -37,7 +32,7 @@ and services have behaviour, in the form
* [How to specify the size of String properties](./how-to-01-120-How-to-specify-the-size-of-String-properties.html)
-* [How to specify the size of String action parameters](./how-to-01-130-How-to-specify-the-size-of-String-action parameters.html)
+* [How to specify the size of String action parameters](./how-to-01-130-How-to-specify-the-size-of-String-action-parameters.html)
* [How to specify names or descriptions for an action parameter](./how-to-01-140-How-to-specify-names-or-descriptions-for-an-action-parameter.html)
@@ -46,12 +41,7 @@ and services have behaviour, in the form
* [How to create or delete objects within your code](./how-to-01-160-How-to-create-or-delete-objects-within-your-code.html)
-How to add business rules
-=========================
-
-> How-to add business rules to domain entities and services, controlling
-> whether a domain entity or service's class members are visible, if
-> they are enabled, and to validate arguments.
+##How to add business rules
Business rules can be added to domain objects in a number of ways. As
well as the business logic encapsulated by domain object actions, the
@@ -90,11 +80,7 @@ Or, in other words: "see it, use it, do
* [How to validate declaratively using MustSatisfy](./how-to-02-130-How-to-validate-declaratively-using-MustSatisfy.html)
-How to provide drop-downs and default values
-============================================
-
-> How-to make actions easier to use from an end-user perspective, by
-> providing sets of choices and defaults.
+##How to provide drop-downs and default values
Invoking actions or setting properties requires that the user specify a
valid value; of the correct type, and that passes any validation rules
@@ -105,7 +91,6 @@ drop-down list box.
In a similar vein, there may be a default value for an action parameter;
this can also be specified.
-
* [How to specify a set of choices for a property](./how-to-03-010-How-to-specify-a-set-of-choices-for-a-property.html)
* [How to specify a set of choices for an action parameter](./how-to-03-020-How-to-specify-a-set-of-choices-for-an-action-parameter.html)
@@ -117,8 +102,7 @@ this can also be specified.
* [How to specify default values for an action parameter](./how-to-03-050-How-to-specify-default-values-for-an-action-parameter.html)
-How to derive properties and collections, and other side-effects
-========
+##How to derive properties and collections, and other side-effects
The *Isis* viewers will automatically render the state of properties and
collections, but the values of such need not be persisted; they can be
@@ -132,15 +116,12 @@ derived from other information available
* [How to trigger other behaviour when a property is changed](./how-to-04-040-How-to-trigger-other-behaviour-when-a-property-is-changed.html)
-* [How to trigger other behaviour when an object is added or removed](./how-to-04-050-How to trigger other behaviour when an object is added or removed.html)
+* [How to trigger other behaviour when an object is added or removed](./how-to-04-050-How-to-trigger-other-behaviour-when-an-object-is-added-or-removed.html)
* [How to set up and maintain bidirectional relationships](./how-to-04-060-How-to-set-up-and-maintain-bidirectional-relationships.html)
-How to provide additional UI hints
-==================================
-
-> How to override Isis' defaults for presentation.
+##How to provide additional UI hints
With the exception of value types for action parameters <!--(see ?)-->, Isis
can normally infer a reasonable name for entity/service and its class
@@ -158,7 +139,7 @@ been placed vs one that has been shipped
* [How to specify a name or description for a property](./how-to-05-020-How-to-specify-a-name-or-description-for-a-property.html)
-* [How to specify a name or description for a collection](./how-to-05-030-How to specify a name or description for a collection.html)
+* [How to specify a name or description for a collection](./how-to-05-030-How-to-specify-a-name-or-description-for-a-collection.html)
* [How to specify names or description for an action](./how-to-05-040-How-to-specify-names-or-description-for-an-action.html)
@@ -166,10 +147,7 @@ been placed vs one that has been shipped
-How to deal with errors
-=======================
-
-> How to inform the user if an error occurs.
+##How to deal with errors
Things go wrong. *Isis* handles many of the usual error conditions, but
your app may also wish to notify the user also when something goes awry.
@@ -181,11 +159,7 @@ your app may also wish to notify the use
* [How to deal with an unexpected error](./how-to-06-020-How-to-deal-with-an-unexpected-error.html)
-How to handle the entity persistence lifecycle
-==============================================
-
-> How to hook into the entity persistence lifecycle and handle specific
-> scenarios
+##How to handle the entity persistence lifecycle
*Isis* automatically persists domain entities, performing both lazy
loading and dirty object tracking. As an application programmer you can
@@ -205,13 +179,7 @@ get visibility into and influence this b
* [How to perform dirty object tracking](./how-to-07-060-How-to-perform-dirty-object-tracking.html)
-How to handle security concerns
-===============================
-
-> Further validation how-to's that apply across all class members
-
-This chapter has some additional recipes/how-tos relating to
-implementing business rules. They apply across all class members.
+##How to handle security concerns
* [Hiding, disabling or validating for specific users or roles](./how-to-08-010-Hiding,-disabling-or-validating-for-specific-users-or-roles.html)
Added: isis/site/trunk/content/applib-guide/reference/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/applib-guide/reference/about.md?rev=1485636&view=auto
==============================================================================
--- isis/site/trunk/content/applib-guide/reference/about.md (added)
+++ isis/site/trunk/content/applib-guide/reference/about.md Thu May 23 09:55:22 2013
@@ -0,0 +1,13 @@
+Title: Programming Model Reference
+
+* [Recognized Methods and Prefixes](./Recognized-Methods-and-Prefixes.html)
+
+* [Recognized Annotations](./recognized-annotations/about.html)
+
+* [DomainObjectContainer interface](./DomainObjectContainer.html)
+
+* [Security](./Security.html)
+
+* [Applib Utility Classes](./Utility.html)
+
+* [Applib Events](./Event.html)
Copied: isis/site/trunk/content/applib-guide/reference/recognized-annotations/about.md (from r1485623, isis/site/trunk/content/applib-guide/reference/recognized-annotations/000-about.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/applib-guide/reference/recognized-annotations/about.md?p2=isis/site/trunk/content/applib-guide/reference/recognized-annotations/about.md&p1=isis/site/trunk/content/applib-guide/reference/recognized-annotations/000-about.md&r1=1485623&r2=1485636&rev=1485636&view=diff
==============================================================================
--- isis/site/trunk/content/applib-guide/reference/recognized-annotations/000-about.md (original)
+++ isis/site/trunk/content/applib-guide/reference/recognized-annotations/about.md Thu May 23 09:55:22 2013
@@ -18,8 +18,8 @@ Recognized Annotations
* [Facets](./Facets.html)
* [FieldOrder](./FieldOrder.html)
* [Hidden](./Hidden.html)
-* [Idempotent (deprecated)](./Idempotent (deprecated).html)
-* [Ignore (deprecated)](./Ignore (deprecated).html)
+* [Idempotent (deprecated)](./Idempotent-(deprecated).html)
+* [Ignore (deprecated)](./Ignore-(deprecated).html)
* [Immutable](./Immutable.html)
* [Mask](./Mask.html)
* [MaxLength](./MaxLength.html)
@@ -41,7 +41,7 @@ Recognized Annotations
* [Prototype](./Prototype.html)
* [PublishedAction](./PublishedAction.html)
* [PublishedObject](./PublishedObject.html)
-* [QueryOnly](./QueryOnly.html)
+* [QueryOnly (deprecated)](./QueryOnly-(deprecated).html)
* [RegEx](./RegEx.html)
* [Render](./Render.html)
* [Resolve](./Resolve.html)
Copied: isis/site/trunk/content/applib-guide/value-types/about.md (from r1485623, isis/site/trunk/content/applib-guide/value-types/000-about.md)
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/applib-guide/value-types/about.md?p2=isis/site/trunk/content/applib-guide/value-types/about.md&p1=isis/site/trunk/content/applib-guide/value-types/000-about.md&r1=1485623&r2=1485636&rev=1485636&view=diff
==============================================================================
--- isis/site/trunk/content/applib-guide/value-types/000-about.md (original)
+++ isis/site/trunk/content/applib-guide/value-types/about.md Thu May 23 09:55:22 2013
@@ -1,9 +1,6 @@
Value Types
===========
-> Built-in value types, writing your own value types, and supporting
-> third-party value types.
-
The state of any given entity is characterized by properties <!--(?)--> and
collections <!--(?)-->. A collections is a one-to-many reference to another
entities, while a property is either a one-to-one reference to another
@@ -24,11 +21,11 @@ value types. *Isis* provides one such i
For more information, see:
-* [Built-in Value Types](./value-types/020-Built-in-Value-Types.html)
+* [Built-in Value Types](./010-Built-in-Value-Types.html)
-* [Custom Value Types](./value-types/030-Custom-Value-Types]
+* [Custom Value Types](./020-Custom-Value-Types.html]
-* [Third-party Value Types](./value-types/04-Third-party-Value-Types.html)
+* [Third-party Value Types](./030-Third-party-Value-Types.html)
> **Note**
>
@@ -38,7 +35,7 @@ For more information, see:
> expected to have equal-by-content semantics, and is expected to be
> immutable. It may also be parseable from a string.
-> **Note**
+
>
> Also, if using the JDO/DataNucleus ObjectStore, you may also need to perform additional DataNucleus-specific configuration if you want the data to be persisted in a SQL datatype other than SQL Blob (ie a serializable byte array).