From 7f9b60d66f5725da167b877cb4c5707d05c9112e Mon Sep 17 00:00:00 2001
From: Eric Espie <eric.espie@combodo.com>
Date: Wed, 27 Mar 2024 11:11:55 +0100
Subject: [PATCH] =?UTF-8?q?N=C2=B05913=20-=20Add=20Event=20Listener=20meth?=
 =?UTF-8?q?ods=20&=20enhance=20methods=20management?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 application/datamodel.application.xml         | 61 +++++++++++++------
 .../datamodel.itop-attachments.xml            |  6 +-
 .../datamodel.itop-portal-base.xml            |  3 +-
 3 files changed, 49 insertions(+), 21 deletions(-)

diff --git a/application/datamodel.application.xml b/application/datamodel.application.xml
index c1028d42f..c95ceae79 100644
--- a/application/datamodel.application.xml
+++ b/application/datamodel.application.xml
@@ -187,7 +187,9 @@
   </menus>
   <events>
     <event id="EVENT_DB_BEFORE_WRITE" _delta="define">
-      <description>An object is about to be written into the database. The object can be modified.</description>
+      <name>Before create or update</name>
+      <description><![CDATA[An object is about to be written into the database.
+The object can be modified.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -208,7 +210,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_CHECK_TO_WRITE" _delta="define">
-      <description>Check an object before it is written into the database (no change possible). Call DBObject::AddCheckIssue() to signal an issue</description>
+      <name>Check to write</name>
+      <description><![CDATA[Check an object before it is written into the database (no change possible).
+Call $this->AddCheckIssue() to signal an issue.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -229,7 +233,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_AFTER_WRITE" _delta="define">
-      <description>An object has been written into the database. The modifications can be propagated to other objects.</description>
+      <name>After create or update</name>
+      <description><![CDATA[An object has been written into the database.
+The modifications can be propagated to other objects.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -244,7 +250,7 @@
           <type>boolean</type>
         </event_datum>
         <event_datum id="changes">
-          <description>For updates, the list of changes done during this operation</description>
+          <description><![CDATA[For updates, the list of changes done during this operation]]></description>
           <type>array</type>
         </event_datum>
         <event_datum id="debug_info">
@@ -254,7 +260,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_CHECK_TO_DELETE" _delta="define">
-      <description>Check an object before it is deleted from the database. Call DBObject::AddDeleteIssue() to signal an issue</description>
+      <name>Check to delete</name>
+      <description><![CDATA[Check an object before it is deleted from the database.
+Call $this->AddDeleteIssue() to signal an issue.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -271,7 +279,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_ABOUT_TO_DELETE" _delta="define">
-      <description>An object is about to be deleted from the database</description>
+      <name>Before delete</name>
+      <description><![CDATA[An object is about to be deleted from the database]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -288,7 +297,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_AFTER_DELETE" _delta="define">
-      <description>An object has been deleted into the database</description>
+      <name>After delete</name>
+      <description><![CDATA[An object has been deleted into the database]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -305,7 +315,9 @@
       </event_data>
     </event>
     <event id="EVENT_ENUM_TRANSITIONS" _delta="define">
-      <description>Manage the allowed transitions in current object state. The only action allowed is to deny transitions with DBObject::DenyTransition()</description>
+      <name>Enum transitions</name>
+      <description><![CDATA[Manage the allowed transitions in current object state.
+The only action allowed is to deny transitions with $this->DenyTransition()]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -325,7 +337,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_LINKS_CHANGED" _delta="define">
-      <description>At least one link class was changed</description>
+      <name>Links on object have changed</name>
+      <description><![CDATA[At least one link class was changed]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -341,7 +354,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_OBJECT_RELOAD" _delta="define">
-      <description>An object has been re-loaded from the database</description>
+      <name>Object reload</name>
+      <internal>true</internal>
+      <description><![CDATA[An object has been re-loaded from the database]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -357,7 +372,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_COMPUTE_VALUES" _delta="define">
-      <description>An object needs to be recomputed after changes</description>
+      <name>Recompute object values</name>
+      <description><![CDATA[An object needs to be recomputed after changes]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -374,7 +390,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_ARCHIVE" _delta="define">
-      <description>An object has been archived</description>
+      <name>Object archived</name>
+      <description><![CDATA[An object has been archived]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -390,7 +407,8 @@
       </event_data>
     </event>
     <event id="EVENT_DB_UNARCHIVE" _delta="define">
-      <description>An object has been unarchived</description>
+      <name>Object unarchived</name>
+      <description><![CDATA[An object has been unarchived]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -406,7 +424,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_SET_ATTRIBUTES_FLAGS" _delta="define">
-      <description>Set object attributes flags. Call cmdbAbstractObject::AddAttributeFlags() for all the attributes to be set for this target state.</description>
+      <name>Set attributes flags</name>
+      <description><![CDATA[Set object attributes flags.
+Call $this->AddAttributeFlags() for all the attributes to be set for this target state.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -417,7 +437,7 @@
         </event_datum>
         <event_datum id="target_state">
           <description>The target state in which to evaluate the flags</description>
-          <type>array</type>
+          <type>string</type>
         </event_datum>
         <event_datum id="debug_info">
           <description>Debug string</description>
@@ -426,7 +446,9 @@
       </event_data>
     </event>
     <event id="EVENT_DB_SET_INITIAL_ATTRIBUTES_FLAGS" _delta="define">
-      <description>Set object initial attributes flags. Call cmdbAbstractObject::AddInitialAttributeFlags() for all the initial attributes to be set initially.</description>
+      <name>Set initial attributes flags</name>
+      <description><![CDATA[Set object initial attributes flags.
+Call $this->AddInitialAttributeFlags() for all the initial attributes to be set initially.]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>
@@ -442,7 +464,8 @@
       </event_data>
     </event>
     <event id="EVENT_DOWNLOAD_DOCUMENT" _delta="define">
-      <description>A document has been downloaded from the GUI</description>
+      <name>Document downloaded</name>
+      <description><![CDATA[A document has been downloaded from the GUI]]></description>
       <sources>
         <source id="Document">Document</source>
       </sources>
@@ -462,7 +485,9 @@
       </event_data>
     </event>
     <event id="EVENT_LOGIN" _delta="define">
-      <description>Inform the listeners about the connection states</description>
+      <name>Login</name>
+      <internal>true</internal>
+      <description><![CDATA[Inform the listeners about the connection states]]></description>
       <event_data>
         <event_datum id="code">
           <description>The login step result code (LoginWebPage::EXIT_CODE_...) </description>
diff --git a/datamodels/2.x/itop-attachments/datamodel.itop-attachments.xml b/datamodels/2.x/itop-attachments/datamodel.itop-attachments.xml
index 2f21cea7a..521a37e9d 100755
--- a/datamodels/2.x/itop-attachments/datamodel.itop-attachments.xml
+++ b/datamodels/2.x/itop-attachments/datamodel.itop-attachments.xml
@@ -260,7 +260,8 @@
   </classes>
   <events>
     <event id="EVENT_ADD_ATTACHMENT_TO_OBJECT" _delta="define">
-      <description>An attachment has been added to an object</description>
+      <name>Attachment added</name>
+      <description><![CDATA[An attachment has been added to an object]]></description>
       <replaces>Attachment::AfterUpdate</replaces>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
@@ -281,7 +282,8 @@
       </event_data>
     </event>
     <event id="EVENT_REMOVE_ATTACHMENT_FROM_OBJECT" _delta="define">
-      <description>An attachment has been removed from an object</description>
+      <name>Attachment removed</name>
+      <description><![CDATA[An attachment has been removed from an object]]></description>
       <replaces>Attachment::AfterUpdate</replaces>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
diff --git a/datamodels/2.x/itop-portal-base/datamodel.itop-portal-base.xml b/datamodels/2.x/itop-portal-base/datamodel.itop-portal-base.xml
index 68f2874f7..a96dc9ace 100644
--- a/datamodels/2.x/itop-portal-base/datamodel.itop-portal-base.xml
+++ b/datamodels/2.x/itop-portal-base/datamodel.itop-portal-base.xml
@@ -2,7 +2,8 @@
 <itop_design version="3.1">
   <events>
     <event id="EVENT_DISPLAY_OBJECT_DETAILS" _delta="define">
-      <description>An object details is about to be displayed to a user</description>
+      <name>Portal object displayed</name>
+      <description><![CDATA[An object details is about to be displayed to a user on a portal]]></description>
       <sources>
         <source id="cmdbAbstractObject">cmdbAbstractObject</source>
       </sources>