From b118e0b0e21318af0d2f0c86ec9b5a9a40796e66 Mon Sep 17 00:00:00 2001
From: "d.lechner" <d.lechner@adito.de>
Date: Thu, 5 Sep 2019 10:53:49 +0200
Subject: [PATCH] Documentation Address
---
entity/AddressType_entity/AddressType_entity.aod | 2 ++
entity/AddressType_entity/documentation.adoc | 8 ++++++++
.../entityfields/bycategory/documentation.adoc | 4 ++++
.../AddressValidation_entity/AddressValidation_entity.aod | 4 ++++
entity/AddressValidation_entity/documentation.adoc | 6 +++++-
.../entityfields/cityvalidation/documentation.adoc | 4 ++++
.../entityfields/fulladdressvalidation/documentation.adoc | 4 ++++
.../entityfields/streetvalidation/documentation.adoc | 4 ++++
.../entityfields/zipvalidaton/documentation.adoc | 4 ++++
entity/Address_entity/Address_entity.aod | 3 +++
entity/Address_entity/documentation.adoc | 2 +-
.../entityfields/contactaddresses/documentation.adoc | 4 ++++
.../entityfields/organisationaddresses/documentation.adoc | 4 ++++
.../organisationaddressesbycontact/documentation.adoc | 3 +++
.../organisationandcontactaddresses/documentation.adoc | 4 ++++
15 files changed, 58 insertions(+), 2 deletions(-)
create mode 100644 entity/AddressType_entity/documentation.adoc
create mode 100644 entity/AddressType_entity/entityfields/bycategory/documentation.adoc
create mode 100644 entity/AddressValidation_entity/entityfields/cityvalidation/documentation.adoc
create mode 100644 entity/AddressValidation_entity/entityfields/fulladdressvalidation/documentation.adoc
create mode 100644 entity/AddressValidation_entity/entityfields/streetvalidation/documentation.adoc
create mode 100644 entity/AddressValidation_entity/entityfields/zipvalidaton/documentation.adoc
create mode 100644 entity/Address_entity/entityfields/contactaddresses/documentation.adoc
create mode 100644 entity/Address_entity/entityfields/organisationaddresses/documentation.adoc
create mode 100644 entity/Address_entity/entityfields/organisationandcontactaddresses/documentation.adoc
diff --git a/entity/AddressType_entity/AddressType_entity.aod b/entity/AddressType_entity/AddressType_entity.aod
index 3fbbc3eeaf..235505e9fe 100644
--- a/entity/AddressType_entity/AddressType_entity.aod
+++ b/entity/AddressType_entity/AddressType_entity.aod
@@ -2,6 +2,7 @@
<entity xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.3.11" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/entity/1.3.11">
<name>AddressType_entity</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
+ <documentation>%aditoprj%/entity/AddressType_entity/documentation.adoc</documentation>
<contentTitleProcess>%aditoprj%/entity/AddressType_entity/contentTitleProcess.js</contentTitleProcess>
<recordContainer>db</recordContainer>
<entityFields>
@@ -20,6 +21,7 @@
<entityProvider>
<name>ByCategory</name>
<lookupIdfield>KEYID</lookupIdfield>
+ <documentation>%aditoprj%/entity/AddressType_entity/entityfields/bycategory/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>0956b1f3-8b67-4f82-b04a-70be88aff19f</name>
diff --git a/entity/AddressType_entity/documentation.adoc b/entity/AddressType_entity/documentation.adoc
new file mode 100644
index 0000000000..e3e7dc1f4e
--- /dev/null
+++ b/entity/AddressType_entity/documentation.adoc
@@ -0,0 +1,8 @@
+AddressType_entity
+=======
+
+Displays the AdressType Keyword ($KeywordRegistry.addressType()).
+In the condition of the recordcontainer the entity differs between organisation and contact.
+
+You need a own entty for this case because the KeywordEntry_entity
+provides all information without checking conditions for KeywordAttribute.
\ No newline at end of file
diff --git a/entity/AddressType_entity/entityfields/bycategory/documentation.adoc b/entity/AddressType_entity/entityfields/bycategory/documentation.adoc
new file mode 100644
index 0000000000..2d78a940ac
--- /dev/null
+++ b/entity/AddressType_entity/entityfields/bycategory/documentation.adoc
@@ -0,0 +1,4 @@
+AddressType_entity - ByCategory
+=======
+
+Filter for a category in the $KeywordRegistry.addressType().
\ No newline at end of file
diff --git a/entity/AddressValidation_entity/AddressValidation_entity.aod b/entity/AddressValidation_entity/AddressValidation_entity.aod
index 6fa4fbffda..7aec3da723 100644
--- a/entity/AddressValidation_entity/AddressValidation_entity.aod
+++ b/entity/AddressValidation_entity/AddressValidation_entity.aod
@@ -16,6 +16,7 @@
</entityField>
<entityProvider>
<name>ZipValidaton</name>
+ <documentation>%aditoprj%/entity/AddressValidation_entity/entityfields/zipvalidaton/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>fcfcbebe-260a-4773-a874-9791b4887ae2</name>
@@ -73,6 +74,7 @@
</entityField>
<entityProvider>
<name>CityValidation</name>
+ <documentation>%aditoprj%/entity/AddressValidation_entity/entityfields/cityvalidation/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>27114db7-8562-43b2-87d8-fa605bbf2319</name>
@@ -96,6 +98,7 @@
</entityParameter>
<entityProvider>
<name>FullAddressValidation</name>
+ <documentation>%aditoprj%/entity/AddressValidation_entity/entityfields/fulladdressvalidation/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>10f700b5-1ac6-4d50-bcb8-aae55714fb43</name>
@@ -130,6 +133,7 @@
</entityField>
<entityProvider>
<name>StreetValidation</name>
+ <documentation>%aditoprj%/entity/AddressValidation_entity/entityfields/streetvalidation/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>3211d147-0867-4fc1-8640-34a1b8fdcf18</name>
diff --git a/entity/AddressValidation_entity/documentation.adoc b/entity/AddressValidation_entity/documentation.adoc
index 9b4c189ce8..9705cab82f 100644
--- a/entity/AddressValidation_entity/documentation.adoc
+++ b/entity/AddressValidation_entity/documentation.adoc
@@ -1 +1,5 @@
-See WsValidation_lib
\ No newline at end of file
+AddressValidation_entity
+=======
+
+The entity handels the logic of the address validation.
+For details see WsValidation_lib
\ No newline at end of file
diff --git a/entity/AddressValidation_entity/entityfields/cityvalidation/documentation.adoc b/entity/AddressValidation_entity/entityfields/cityvalidation/documentation.adoc
new file mode 100644
index 0000000000..dcbc5a19c2
--- /dev/null
+++ b/entity/AddressValidation_entity/entityfields/cityvalidation/documentation.adoc
@@ -0,0 +1,4 @@
+AddressValidation_entity - CityValidation
+=======
+
+Provider for validating city only
\ No newline at end of file
diff --git a/entity/AddressValidation_entity/entityfields/fulladdressvalidation/documentation.adoc b/entity/AddressValidation_entity/entityfields/fulladdressvalidation/documentation.adoc
new file mode 100644
index 0000000000..4a457109a1
--- /dev/null
+++ b/entity/AddressValidation_entity/entityfields/fulladdressvalidation/documentation.adoc
@@ -0,0 +1,4 @@
+AddressValidation_entity - FullAddressValidation
+=======
+
+Provider for validating the complete address
\ No newline at end of file
diff --git a/entity/AddressValidation_entity/entityfields/streetvalidation/documentation.adoc b/entity/AddressValidation_entity/entityfields/streetvalidation/documentation.adoc
new file mode 100644
index 0000000000..7cbd06b4da
--- /dev/null
+++ b/entity/AddressValidation_entity/entityfields/streetvalidation/documentation.adoc
@@ -0,0 +1,4 @@
+AddressValidation_entity - StreetValidation
+=======
+
+Provider for validating street only
\ No newline at end of file
diff --git a/entity/AddressValidation_entity/entityfields/zipvalidaton/documentation.adoc b/entity/AddressValidation_entity/entityfields/zipvalidaton/documentation.adoc
new file mode 100644
index 0000000000..39f0244b92
--- /dev/null
+++ b/entity/AddressValidation_entity/entityfields/zipvalidaton/documentation.adoc
@@ -0,0 +1,4 @@
+AddressValidation_entity - ZipValidation
+=======
+
+Provider for validating zip only
\ No newline at end of file
diff --git a/entity/Address_entity/Address_entity.aod b/entity/Address_entity/Address_entity.aod
index 83f0fe8541..56de903b81 100644
--- a/entity/Address_entity/Address_entity.aod
+++ b/entity/Address_entity/Address_entity.aod
@@ -88,6 +88,7 @@
</entityField>
<entityProvider>
<name>OrganisationAddresses</name>
+ <documentation>%aditoprj%/entity/Address_entity/entityfields/organisationaddresses/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>b484b43c-16f6-4875-9787-f0813dd200cb</name>
@@ -125,6 +126,7 @@
</entityParameter>
<entityProvider>
<name>ContactAddresses</name>
+ <documentation>%aditoprj%/entity/Address_entity/entityfields/contactaddresses/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>efdb2f19-ab41-4f49-941a-843610e2b31b</name>
@@ -219,6 +221,7 @@
</entityParameter>
<entityProvider>
<name>OrganisationAndContactAddresses</name>
+ <documentation>%aditoprj%/entity/Address_entity/entityfields/organisationandcontactaddresses/documentation.adoc</documentation>
<dependencies>
<entityDependency>
<name>4d7e3b3a-abba-4429-9f1e-18e11788c0f2</name>
diff --git a/entity/Address_entity/documentation.adoc b/entity/Address_entity/documentation.adoc
index e43e482a61..2aaae7c32c 100644
--- a/entity/Address_entity/documentation.adoc
+++ b/entity/Address_entity/documentation.adoc
@@ -1,4 +1,4 @@
-Address
+Address_entity
=======
----
diff --git a/entity/Address_entity/entityfields/contactaddresses/documentation.adoc b/entity/Address_entity/entityfields/contactaddresses/documentation.adoc
new file mode 100644
index 0000000000..14d14b294c
--- /dev/null
+++ b/entity/Address_entity/entityfields/contactaddresses/documentation.adoc
@@ -0,0 +1,4 @@
+Address_entity - ContactAddresses
+=======
+
+Provides all addresses for contacts
\ No newline at end of file
diff --git a/entity/Address_entity/entityfields/organisationaddresses/documentation.adoc b/entity/Address_entity/entityfields/organisationaddresses/documentation.adoc
new file mode 100644
index 0000000000..f2e5646590
--- /dev/null
+++ b/entity/Address_entity/entityfields/organisationaddresses/documentation.adoc
@@ -0,0 +1,4 @@
+Address_entity - OrganisationAddresses
+=======
+
+Provides all addresses for organisations
\ No newline at end of file
diff --git a/entity/Address_entity/entityfields/organisationaddressesbycontact/documentation.adoc b/entity/Address_entity/entityfields/organisationaddressesbycontact/documentation.adoc
index 6eb2a8e848..113d24db69 100644
--- a/entity/Address_entity/entityfields/organisationaddressesbycontact/documentation.adoc
+++ b/entity/Address_entity/entityfields/organisationaddressesbycontact/documentation.adoc
@@ -1,3 +1,6 @@
+Address_entity - OrganisationAddressesByContact
+=======
+
Get the organisation addresses of a contact. The organisation is loaded by the contact of the contact.
You have to provide the contact ID from the contact.
diff --git a/entity/Address_entity/entityfields/organisationandcontactaddresses/documentation.adoc b/entity/Address_entity/entityfields/organisationandcontactaddresses/documentation.adoc
new file mode 100644
index 0000000000..bf81e80f68
--- /dev/null
+++ b/entity/Address_entity/entityfields/organisationandcontactaddresses/documentation.adoc
@@ -0,0 +1,4 @@
+Address_entity - OrganisationAndContactAdresses
+=======
+
+Provides all addresses for both organisations and contacts (without an filter)
\ No newline at end of file
--
GitLab