diff --git a/src/doc/specification/RecordType.rst b/src/doc/specification/RecordType.rst index 040b79b20be74eb65a791ef237e67114783531c6..bb885bc4338cc8aaa43ef252022722e1cdab207b 100644 --- a/src/doc/specification/RecordType.rst +++ b/src/doc/specification/RecordType.rst @@ -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 with a warning, or is executed without a warning, respectively. The 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:: diff --git a/src/main/java/org/caosdb/server/entity/StatementStatus.java b/src/main/java/org/caosdb/server/entity/StatementStatus.java index b3d7a613d26eba432308272b3bd932d2fdb54b26..b9c9fafccfe3efff6ed69acbc68e5f69609c989e 100644 --- a/src/main/java/org/caosdb/server/entity/StatementStatus.java +++ b/src/main/java/org/caosdb/server/entity/StatementStatus.java @@ -23,13 +23,24 @@ 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. - * 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. + * <p> 1. Storing the importance of an entity (any of ``OBLIGATORY``, + * ``RECOMMENDED``, ``SUGGESTED``, or ``FIX``). ``OBLIGATORY``, + * ``RECOMMENDED``, and ``SUGGESTED`` specify whether this Entity + * must, should or may be present, and whether the server will throw + * 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) */