Artefact Types that can be Deprecated

The following artefact types may be deprecated:

Table 1. Artefact Types that can be Deprecated
Area Artefact Type
Modeled Artefacts Process Class, Entity Class, Struct Class, Process Method, Entity Method.
Java Code Identical to Java deprecation (Class, Interface, Method, Attribute, etc)
Client Artefacts UIM Page, VIM file, Page Property (.property associated with a UIM or VIM file)
Messages Message Catalog Entry

All of these artefact types support explanatory comments attached to the deprecation tag. These can be easily found by searching for the string 'deprecated' within the artefact in question. For .java files (and model artefacts), the @deprecated JavaDoc tag is used in the normal way. For XML files such as UIM/VIM files and message catalog entries, the <?curam-deprecated XML processing instruction is used. Finally, in property files, the string .deprecated is appended to the name of a property to denote that that property is deprecated.

Entity Classes: Please note that for Entity Classes, the term 'deprecation' refers entirely to the generated Java artefacts derived from the Entity and does not refer to data associated with that entity. The Cúram Generator produces no database schema representation for a deprecated Entity, it is expected that this data has migrated to another Entity (or Entities). Entities are deprecated in order to minimize the code impact of changes to the data model. The deprecated Entity's purpose is to re-route method calls to the appropriate replacement Entity (or Entities). As such, deprecated Entities follow the same pattern as other classes - references to the entity will continue to function as before, customizations (overrides) will not.