From 9a06e1b367da863a5566c4868884c5709f911038 Mon Sep 17 00:00:00 2001
From: "a.schindlbeck" <a.schindlbeck@adito.de>
Date: Thu, 7 Feb 2019 16:28:53 +0100
Subject: [PATCH] #1030874 Doku Appointment Context
---
.../Appointment_entity/Appointment_entity.aod | 19 ++++----
entity/Appointment_entity/documentation.adoc | 32 +++++++++++++
entity/Offer_entity/documentation.adoc | 4 +-
.../Appointment_context.aod | 45 ++++++++++---------
.../Appointment_context/documentation.adoc | 11 +++++
.../AppointmentEdit_view.aod | 4 +-
.../AppointmentEdit_view/documentation.adoc | 13 ++++++
.../AppointmentPreview_view.aod | 1 +
.../documentation.adoc | 12 +++++
9 files changed, 105 insertions(+), 36 deletions(-)
create mode 100644 entity/Appointment_entity/documentation.adoc
create mode 100644 neonContext/Appointment_context/documentation.adoc
create mode 100644 neonView/AppointmentEdit_view/documentation.adoc
create mode 100644 neonView/AppointmentPreview_view/documentation.adoc
diff --git a/entity/Appointment_entity/Appointment_entity.aod b/entity/Appointment_entity/Appointment_entity.aod
index 097d4bb5caf..e00455cf979 100644
--- a/entity/Appointment_entity/Appointment_entity.aod
+++ b/entity/Appointment_entity/Appointment_entity.aod
@@ -3,7 +3,8 @@
<name>Appointment_entity</name>
<title>Termin</title>
<majorModelMode>DISTRIBUTED</majorModelMode>
- <recordContainer>jdito</recordContainer>
+ <documentation>%aditoprj%/entity/Appointment_entity/documentation.adoc</documentation>
+ <recordContainer>jDitoRC</recordContainer>
<entityFields>
<entityField>
<name>SUMMARY</name>
@@ -87,10 +88,9 @@
</entityActionGroup>
<entityProvider>
<name>#PROVIDER</name>
- <recordContainer>jdito</recordContainer>
</entityProvider>
<entityParameter>
- <name>MasterEntry_param</name>
+ <name>masterEntry</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
@@ -125,21 +125,21 @@
<name>ICON</name>
</entityField>
<entityParameter>
- <name>Entry_param</name>
+ <name>entry</name>
<expose v="true" />
<description>PARAMETER</description>
</entityParameter>
</entityFields>
<recordContainers>
<jDitoRecordContainer>
- <name>jdito</name>
+ <name>jDitoRC</name>
<title>jDitoRC</title>
<description></description>
<jDitoRecordAlias>_____SYSTEMALIAS</jDitoRecordAlias>
- <contentProcess>%aditoprj%/entity/Appointment_entity/recordcontainers/jdito/contentProcess.js</contentProcess>
- <onInsert>%aditoprj%/entity/Appointment_entity/recordcontainers/jdito/onInsert.js</onInsert>
- <onUpdate>%aditoprj%/entity/Appointment_entity/recordcontainers/jdito/onUpdate.js</onUpdate>
- <onDelete>%aditoprj%/entity/Appointment_entity/recordcontainers/jdito/onDelete.js</onDelete>
+ <contentProcess>%aditoprj%/entity/Appointment_entity/recordcontainers/jditorc/contentProcess.js</contentProcess>
+ <onInsert>%aditoprj%/entity/Appointment_entity/recordcontainers/jditorc/onInsert.js</onInsert>
+ <onUpdate>%aditoprj%/entity/Appointment_entity/recordcontainers/jditorc/onUpdate.js</onUpdate>
+ <onDelete>%aditoprj%/entity/Appointment_entity/recordcontainers/jditorc/onDelete.js</onDelete>
<recordFields>
<element>UID.value</element>
<element>ATTENDEESLENGTH.value</element>
@@ -167,3 +167,4 @@
</jDitoRecordContainer>
</recordContainers>
</entity>
+
diff --git a/entity/Appointment_entity/documentation.adoc b/entity/Appointment_entity/documentation.adoc
new file mode 100644
index 00000000000..263e85f66ff
--- /dev/null
+++ b/entity/Appointment_entity/documentation.adoc
@@ -0,0 +1,32 @@
+= Appointment-Entity
+
+:hardbreaks:
+
+The Appointment-Entity is a special kind of an Adito-Entity.
+It is not directly connected to the database, instead it uses a JDito-Record-Container that transfers the Appointment-Entries
+via Entity-Parameters between Core and JDito.
+
+== Fields
+
+"Damn, thats a truckload of Fields in here." - Yes, it is.
+Every field in this entity has its own important purpose.
+All of them fit exactly to the field-slots of the Appointment-Viewtemplates, Edit and Preview, that are highly special for their own.
+(see: documentation of AppointmentEdit_view and AppointmentPreview_view)
+
+
+== Params
+
+_entry_ : A complete Appointment object
+_masterentry_ : The masterentry of the Appointment in the entry-param (only set if _entry_ is part of a series)
+
+== Actions
+
+=== PartStatActionGroup
+
+This action group handles the changes to the ParticipationStatus of every Attendee.
+It is highly recommended to not change neither the name, nor the code of each action without the help of an Adito developer.
+
+===== Actions
+_accept_
+_decline_
+_tentative_
\ No newline at end of file
diff --git a/entity/Offer_entity/documentation.adoc b/entity/Offer_entity/documentation.adoc
index c11de6b8002..98645e67ccc 100644
--- a/entity/Offer_entity/documentation.adoc
+++ b/entity/Offer_entity/documentation.adoc
@@ -7,8 +7,8 @@ It provides data from database table _OFFER_.
== Actions
-* _Copy offer_: All values, offeritems included, are copyed and inserted in a new offer (new offer code, versnr. _1_).
-* _New offer version_: All values, offeritems included, are copyed and inserted in a **new offer version** (versnr. + _1_).
+* _Copy offer_: All values, offeritems included, are copied and inserted in a new offer (new offer code, versnr. _1_).
+* _New offer version_: All values, offeritems included, are copied and inserted in a **new offer version** (versnr. + _1_).
== Submodules
diff --git a/neonContext/Appointment_context/Appointment_context.aod b/neonContext/Appointment_context/Appointment_context.aod
index 96cb8c162a3..2699eb3fc31 100644
--- a/neonContext/Appointment_context/Appointment_context.aod
+++ b/neonContext/Appointment_context/Appointment_context.aod
@@ -1,22 +1,23 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<neonContext xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.0" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonContext/1.0.0">
- <name>Appointment_context</name>
- <title>Termin</title>
- <majorModelMode>DISTRIBUTED</majorModelMode>
- <icon>VAADIN:CALENDAR</icon>
- <mainview>AppointmentEdit_view</mainview>
- <filterview>AppointmentPreview_view</filterview>
- <editview>AppointmentEdit_view</editview>
- <preview>AppointmentPreview_view</preview>
- <entity>Appointment_entity</entity>
- <references>
- <neonViewReference>
- <name>90fe74fe-9bc6-4f63-9c06-52e1b0ccfcb3</name>
- <view>AppointmentEdit_view</view>
- </neonViewReference>
- <neonViewReference>
- <name>9cf48e57-ca02-4cee-911c-20b09e36637d</name>
- <view>AppointmentPreview_view</view>
- </neonViewReference>
- </references>
-</neonContext>
+<?xml version="1.0" encoding="UTF-8"?>
+<neonContext xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.0" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonContext/1.0.0">
+ <name>Appointment_context</name>
+ <title>Termin</title>
+ <majorModelMode>DISTRIBUTED</majorModelMode>
+ <documentation>%aditoprj%/neonContext/Appointment_context/documentation.adoc</documentation>
+ <icon>VAADIN:CALENDAR</icon>
+ <mainview>AppointmentEdit_view</mainview>
+ <filterview>AppointmentPreview_view</filterview>
+ <editview>AppointmentEdit_view</editview>
+ <preview>AppointmentPreview_view</preview>
+ <entity>Appointment_entity</entity>
+ <references>
+ <neonViewReference>
+ <name>90fe74fe-9bc6-4f63-9c06-52e1b0ccfcb3</name>
+ <view>AppointmentEdit_view</view>
+ </neonViewReference>
+ <neonViewReference>
+ <name>9cf48e57-ca02-4cee-911c-20b09e36637d</name>
+ <view>AppointmentPreview_view</view>
+ </neonViewReference>
+ </references>
+</neonContext>
diff --git a/neonContext/Appointment_context/documentation.adoc b/neonContext/Appointment_context/documentation.adoc
new file mode 100644
index 00000000000..5d82bff15ff
--- /dev/null
+++ b/neonContext/Appointment_context/documentation.adoc
@@ -0,0 +1,11 @@
+= Appointment-Context
+
+:hardbreaks:
+
+This context handels all the needs of appointments for the Adito calendar.
+Even with an exchange connection. Wow.
+
+== Important!
+
+Its entity and viewtemplates are highly connected to the Adito core.
+It's recommended to not change or delete anything without the presence of an Adito dev.
\ No newline at end of file
diff --git a/neonView/AppointmentEdit_view/AppointmentEdit_view.aod b/neonView/AppointmentEdit_view/AppointmentEdit_view.aod
index dd2855d9258..53d7306a984 100644
--- a/neonView/AppointmentEdit_view/AppointmentEdit_view.aod
+++ b/neonView/AppointmentEdit_view/AppointmentEdit_view.aod
@@ -2,6 +2,7 @@
<neonView xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.1" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonView/1.0.1">
<name>AppointmentEdit_view</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
+ <documentation>%aditoprj%/neonView/AppointmentEdit_view/documentation.adoc</documentation>
<layout>
<boxLayout>
<name>layout</name>
@@ -32,8 +33,5 @@
<reminderField>REMINDER</reminderField>
<entityField>#ENTITY</entityField>
</appointmentEditViewTemplate>
- <genericMultipleViewTemplate>
- <name>GenericMultiple</name>
- </genericMultipleViewTemplate>
</children>
</neonView>
diff --git a/neonView/AppointmentEdit_view/documentation.adoc b/neonView/AppointmentEdit_view/documentation.adoc
new file mode 100644
index 00000000000..32ccf41ac6c
--- /dev/null
+++ b/neonView/AppointmentEdit_view/documentation.adoc
@@ -0,0 +1,13 @@
+= Appointment-Edit-View
+
+:hardbreaks:
+
+This View shows an Appointment in its full extent.
+
+Every change that can be done to an Appointment, can be done in this view.
+It is the container for only one Viewtemplate, the AppointmentEditViewtemplate
+
+=== Attention
+
+**The AppointmentEditViewTemplate can't be chosen by the "add new viewtemplate to view"-dialog.**
+**Deleting the AppointmentEditViewtemplate leads to a state, in which only an Adito dev can add one.**
\ No newline at end of file
diff --git a/neonView/AppointmentPreview_view/AppointmentPreview_view.aod b/neonView/AppointmentPreview_view/AppointmentPreview_view.aod
index 9408a11eab8..e01251e96f3 100644
--- a/neonView/AppointmentPreview_view/AppointmentPreview_view.aod
+++ b/neonView/AppointmentPreview_view/AppointmentPreview_view.aod
@@ -2,6 +2,7 @@
<neonView xmlns="http://www.adito.de/2018/ao/Model" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" VERSION="1.0.1" xsi:schemaLocation="http://www.adito.de/2018/ao/Model adito://models/xsd/neonView/1.0.1">
<name>AppointmentPreview_view</name>
<majorModelMode>DISTRIBUTED</majorModelMode>
+ <documentation>%aditoprj%/neonView/AppointmentPreview_view/documentation.adoc</documentation>
<layout>
<boxLayout>
<name>layout</name>
diff --git a/neonView/AppointmentPreview_view/documentation.adoc b/neonView/AppointmentPreview_view/documentation.adoc
new file mode 100644
index 00000000000..a5c2241c59e
--- /dev/null
+++ b/neonView/AppointmentPreview_view/documentation.adoc
@@ -0,0 +1,12 @@
+= Appointment-Preview-View
+
+:hardbreaks:
+
+The Preview-View shows a reduced version of a full appointment.
+
+It is the container for only one Viewtemplate, the AppointmentPreviewViewtemplate
+
+=== Attention
+
+**The AppointmentPreviewViewtemplate can't be chosen by the "add new viewtemplate to view"-dialog.**
+**Deleting the AppointmentPreviewViewtemplate leads to a state, in which only an Adito dev can add one.**
\ No newline at end of file
--
GitLab