Skip to content
Snippets Groups Projects
Commit 3a237f5d authored by florian's avatar florian
Browse files

DOC: Extend in-cod doc of importance

parent e13db0e3
No related branches found
No related tags found
1 merge request!22DOC: Update and extend importance and inheritance
Pipeline #9129 passed
...@@ -51,7 +51,7 @@ setting the `force-missing-obligatory` flag to `ERROR`, `WARN`, or ...@@ -51,7 +51,7 @@ setting the `force-missing-obligatory` flag to `ERROR`, `WARN`, or
without (at least) an obligatory property causes an error, is executed without (at least) an obligatory property causes an error, is executed
with a warning, or is executed without a warning, respectively. The with a warning, or is executed without a warning, respectively. The
importance value ``FIX`` is used for properties that are specific to importance value ``FIX`` is used for properties that are specific to
the Entity itself and is explained :ref:`below <Inheritance>`. the Entity itself and is explained below.
.. note:: .. note::
......
...@@ -23,13 +23,24 @@ ...@@ -23,13 +23,24 @@
package org.caosdb.server.entity; package org.caosdb.server.entity;
/** /**
* The statement status has two purposes. * The statement status has two purposes:
* *
* <p>1. Storing the importance of an entity (any of OBLIGATORY, RECOMMENDED, SUGGESTED, or FIX). 2. * <p> 1. Storing the importance of an entity (any of ``OBLIGATORY``,
* Marking an entity as a REPLACEMENT which is needed for flat representation of deeply nested * ``RECOMMENDED``, ``SUGGESTED``, or ``FIX``). ``OBLIGATORY``,
* properties. This constant is only used for internal processes and has no meaning in the API. That * ``RECOMMENDED``, and ``SUGGESTED`` specify whether this Entity
* is also the reason why this enum is not called "Importance". Apart from that, in most cases its * must, should or may be present, and whether the server will throw
* meaning is identical to the importance of an entity. * an error, a warning or nothing, respectively, if it is missing. The
* importance is also used to specify the level of inheritance whereby
* ``FIX`` means that the entity is never inherited. See <a
* href="../../../../../specification/RecordType.html">the
* documentation of RecordTypes</a> for more information.
*
* <p> 2. Marking an entity as a ``REPLACEMENT`` which is needed for
* flat representation of deeply nested properties. This constant is
* only used for internal processes and has no meaning in the
* API. That is also the reason why this enum is not called
* "Importance". Apart from that, in most cases its meaning is
* identical to the importance of an entity.
* *
* @author Timm Fitschen (t.fitschen@indiscale.com) * @author Timm Fitschen (t.fitschen@indiscale.com)
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment