[Projekt: Entwicklung - Neon][TicketNr.: 1030874][ Technische Doku - Review und Ergänzen]

ADDRESS

entity/Address_entity/Address_entity.aod

@@ -3,6 +3,7 @@
   <name>Address_entity</name>
   <title>Addresses</title>
   <majorModelMode>DISTRIBUTED</majorModelMode>
+  <documentation>%aditoprj%/entity/Address_entity/documentation.adoc</documentation>
   <titleProcess>%aditoprj%/entity/Address_entity/titleProcess.js</titleProcess>
   <recordContainer>db</recordContainer>
   <entityFields>
@@ -23,6 +24,7 @@
     </entityField>
     <entityField>
       <name>ADDR_TYPE</name>
+      <documentation>%aditoprj%/entity/Address_entity/entityfields/addr_type/documentation.adoc</documentation>
       <title>Addresstype</title>
       <possibleItemsProcess>%aditoprj%/entity/Address_entity/entityfields/addr_type/possibleItemsProcess.js</possibleItemsProcess>
     </entityField>
@@ -96,7 +98,7 @@
     <entityParameter>
       <name>RelId_param</name>
       <expose v="true" />
-      <description>PARAMETER</description>
+      <documentation>%aditoprj%/entity/Address_entity/entityfields/relid_param/documentation.adoc</documentation>
     </entityParameter>
     <entityIncomingField>
       <name>PersAddress_dfi</name>
@@ -126,6 +128,7 @@
     <entityIncomingField>
       <name>PersOrgsAddresses_dfi</name>
       <fieldType>DEPENDENCY_IN</fieldType>
+      <documentation>%aditoprj%/entity/Address_entity/entityfields/persorgsaddresses_dfi/documentation.adoc</documentation>
       <recordContainer>db</recordContainer>
       <dependencies>
         <entityDependency>
@@ -138,6 +141,7 @@
     </entityIncomingField>
     <entityField>
       <name>IS_STANDARD</name>
+      <documentation>%aditoprj%/entity/Address_entity/entityfields/is_standard/documentation.adoc</documentation>
       <contentType>BOOLEAN</contentType>
       <valueProcess>%aditoprj%/entity/Address_entity/entityfields/is_standard/valueProcess.js</valueProcess>
     </entityField>
@@ -145,7 +149,8 @@
       <name>DefaultAddressId_param</name>
       <expose v="true" />
       <triggerRecalculation v="false" />
-      <description>PARAMETER</description>
+      <documentation>%aditoprj%/entity/Address_entity/entityfields/defaultaddressid_param/documentation.adoc</documentation>
+      <description>provide a ADDRESSID-value of the standard address (of a RELATION)</description>
     </entityParameter>
   </entityFields>
   <recordContainers>

entity/Address_entity/documentation.adoc

+Address
+=======
+
+----
+an entity for logic behind a postal address
+----
+
+The entity manages storing postal addresses and provides features like validation.
+
+Every `RELATION` has one standard address value that is used by default for some actions. Keep in mind that this standard address has a special status and therefore may cannot be deleted.

entity/Address_entity/entityfields/addr_type/documentation.adoc

+The `ADDR_TYPE` field represents the type of address (like "shipping address", "private address", etc.)
+
+
+Possible values depend on the type of object it's connect to since a contactperson has different types than a company (organisation).
\ No newline at end of file

entity/Address_entity/entityfields/defaultaddressid_param/documentation.adoc

+`ADDRESSID`-value that specifies which ADDRESSID` is the standard addess of a record. [.small]#See: `IS_STANDARD` field#
+
+There is no validation if the provided value is actually the value of an standard address or a valid `ADDRESSID` at all.
\ No newline at end of file

entity/Address_entity/entityfields/is_standard/documentation.adoc

+The `IS_STANDARD` field specifies if an ADDRESS is the standard address (see Address_entity documentation)
+
+However that information is not stored directly in the `ADDRESS` database table. Every `RELATION`-record has an own standard address.
\ No newline at end of file

entity/Address_entity/entityfields/persorgsaddresses_dfi/documentation.adoc

+Dependency for an arbitrary address of 
+
+ * `ORG` 
+ * `PERS` 
+
+ 
+ 
\ No newline at end of file

entity/Address_entity/entityfields/relid_param/documentation.adoc

+`RELATIONID`-value that is associated with
+
+* an existing address (=filtering)
+* an address that shall be created (=inserted)
\ No newline at end of file