From 55df0bcf9de8c70909bcb989949ef2cdd8f9d121 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=BCrgen=20Plohn?= Date: Fri, 25 Aug 2023 11:43:17 +0200 Subject: [PATCH] update README.md --- persistence-utils-product/README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/persistence-utils-product/README.md b/persistence-utils-product/README.md index 76a3adc..484a121 100644 --- a/persistence-utils-product/README.md +++ b/persistence-utils-product/README.md @@ -19,16 +19,24 @@ Axon Ivy's JPA Persistence Lib utility helps you accelerate process automation i - [APS-156](https://1ivy.atlassian.net/browse/APS-156) Fix handling of session in CriteriaQueryContext - [APS-86](https://1ivy.atlassian.net/browse/APS-86) Use Instant for Auditable Entities create/update/delete - [APS-87](https://1ivy.atlassian.net/browse/APS-87) Rename isEnabled in ToggleableEntity +- [APS-158](https://1ivy.atlassian.net/browse/APS-158) Refactor Type hirachy for Auditable- and ToggleableEntity *Incompatibilities* -- Datatype of **AuditableEntity**s **Header** attributes for create/update and delete date where changed to *Instant* -- Attribute **expiryDate** of **ToggleableEntity** has been renamed to **expiry** and its datatype changed to *Instant* -- Datatype of **ToggleableEntity**s **enabled** has been changed to boolean + +:exclamation::exclamation: **NOTE: This update contains major changes to column names and datatypes as well as refactoring of entity and DAO structure.** +**Please refer to the list of changes mentioned here and in the recommendations** :exclamation::exclamation: + +- Datatype of `AuditableEntity`s `Header` attributes for create/update and delete date where changed to `Instant` +- Attribute `expiryDate` of `ToggleableEntity` has been renamed to **expiry** and its datatype changed to `Instant` +- Datatype of `ToggleableEntity`s **enabled** has been changed to boolean +- `AuditableEntity` and `ToggleableEntity` are now derived from `VersionableEntity` instead of `GenericIdEntity` +- To provide a version of the changed Entities with a predefined `String` id the new Entities `AuditableIdEntity` and `ToggleableIdEntity` and matching DAOs have been introduced *Recommendations* - rename the expiry column to **expiry** unless you have customized the column names anyways. e.g. ALTER TABLE **yourtable** RENAME COLUMN **expiryDate** TO **expiry**. - Make sure there are no *NULL* values for the **enabled** column in your database. The column was defined as not nullable, so only manual changes in the database should have lead to *NULL* values -- use *get/set...AsDate* or *get/set...AsLocalDateTime* methods to get converted datatypes of create/update/delete/expiry *Instant*s +- use `get/set...AsDate` or `get/set...AsLocalDateTime` methods if you need to get converted datatypes of create/modify/delete/expiry `Instant`s +- Change usage of `AuditableEntity` and `ToggleableEntity` to `AuditableIdEntity` and `ToggleableIdEntity`. Use matching DAOs ### 10.0.3 *Changes*