Changes between Version 44 and Version 45 of S3/S3Model/ComponentResources

Timestamp:

02/07/14 10:47:51 (12 years ago)

Author:

Dominic König

Comment:

--

S3/S3Model/ComponentResources

@@ -125 +125 @@
 === Link-Table Components ===
 
-Components can be bound to their master records via link-tables. In such cases, the foreign key constraints for the component link are all in a separate link-table, whereas both the master table and the component table are completely independent:
+Components can be linked to their master records via link-tables. 
+
+In such cases, the foreign key constraints for the component link are stored in a separate link-table:
 
 {{{
@@ -133 +135 @@
 Link-table component links have some advantages over simple foreign key constraints:
 
-  - they can carry attributes of their own (attributed link)
-  - they provide the option to bind the same component record to multiple master records (many-to-many)
+  - link tables can carry attributes of their own (attributed link)
+  - they provide the option to link the same component record to multiple master records (many-to-many)
   - there are several different ways to actuate such links
   - link-table links work both ways (i.e. with master/component exchanged, can be declared both ways at the same time)
@@ -143 +145 @@
   - increased complexity to access and query resources (3 tables instead of 2)
   - increased complexity to handle such links in CRUD and XML/XSLT
-
-==== Link Actuation Options ====
-
-The RESTful methods can handle the link-table in a number of different ways, depending on the CRUD method and the configured option:
-  - ''replace'': hides the link table and always operates on the component table
-  - ''hide'': hides the component table and always operates on the link table
-  - ''link'': operates on the component table for single-record requests, and on the link table for summary requests (=without record ID) and delete
-  - ''embed'': operates on the link table, embeds the component record in single-record requests
-
-The following table gives an overview of link actuation in S3CRUD:
-
-||= CRUD Method =||||||||= Link Actuation Option =||
-||= =||='''replace'''=||='''hide'''=||='''link'''=||='''embed'''=||
-||='''create'''=|| create-form for component || create-form for link || create-form for link || create-form for link with component embedded ||
-||='''read'''=|| read-view of component || read-view of link || read-view of component || read-view of link (with component embedded^2^) ||
-||='''update'''=|| update-form for component || update-form for link || update-form for component || update-form for link with component embedded ||
-||='''delete'''=|| deletes both, component and link || deletes the link || deletes the link^1^ || deletes the link^1^ ||
-||='''list'''=|| list view of component || list view of link || list view of link ||  list view of link (with component embedded^2^) ||
-
-  * ^1^ = deletes the component together with the last link if ''autodelete'' option is set
-  * ^2^ = not implemented yet
-
-Other RESTful methods such as S3Search or S3Report may have their own definitions.
 
 ==== Declaration ====
@@ -187 +166 @@
 If no field is defined for ''autocomplete'', then no autocomplete-widget will be used, but a standard SELECT of options for ''key'' (default behavior).
 
-Important: if you specify a widget for embedding (e.g. S3AddPersonWidget), then you must ensure that the foreign key in the link-table doesn't also use either this widget or any other widget validator!
+  '''Important''': if you specify a widget for embedding (e.g. S3AddPersonWidget), then you must ensure that the foreign key in the link-table doesn't also use either this widget or any other widget validator!
+
+==== Link Actuation Options ====
+
+S3CRUD can handle the link-table in a number of different ways, depending on the method and the configured option:
+  - ''replace'': hides the link table and always operates on the component table
+  - ''hide'': hides the component table and always operates on the link table
+  - ''link'': operates on the component table for single-record requests, and on the link table for summary requests (=without record ID) and delete
+  - ''embed'': operates on the link table, embeds the component record in single-record requests
+
+The following table gives an overview of link actuation in S3CRUD:
+
+||= CRUD Method =||||||||= Link Actuation Option =||
+||= =||='''replace'''=||='''hide'''=||='''link'''=||='''embed'''=||
+||='''create'''=|| create-form for component || create-form for link || create-form for link || create-form for link with component embedded ||
+||='''read'''=|| read-view of component || read-view of link || read-view of component || read-view of link (with component embedded^2^) ||
+||='''update'''=|| update-form for component || update-form for link || update-form for component || update-form for link with component embedded ||
+||='''delete'''=|| deletes both, component and link || deletes the link || deletes the link^1^ || deletes the link^1^ ||
+||='''list'''=|| list view of component || list view of link || list view of link ||  list view of link (with component embedded^2^) ||
+
+  * ^1^ = deletes the component together with the last link if ''autodelete'' option is set
+  * ^2^ = not implemented yet
 
 ----