Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-server
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-server
Commits
3a237f5d
Commit
3a237f5d
authored
3 years ago
by
florian
Browse files
Options
Downloads
Patches
Plain Diff
DOC: Extend in-cod doc of importance
parent
e13db0e3
No related branches found
No related tags found
1 merge request
!22
DOC: Update and extend importance and inheritance
Pipeline
#9129
passed
3 years ago
Stage: test
Stage: deploy
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
src/doc/specification/RecordType.rst
+1
-1
1 addition, 1 deletion
src/doc/specification/RecordType.rst
src/main/java/org/caosdb/server/entity/StatementStatus.java
+17
-6
17 additions, 6 deletions
src/main/java/org/caosdb/server/entity/StatementStatus.java
with
18 additions
and
7 deletions
src/doc/specification/RecordType.rst
+
1
−
1
View file @
3a237f5d
...
@@ -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::
...
...
This diff is collapsed.
Click to expand it.
src/main/java/org/caosdb/server/entity/StatementStatus.java
+
17
−
6
View file @
3a237f5d
...
@@ -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)
*/
*/
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment