jenkins merging release branch into master (strategy: theirs)
[cdm-vaadin.git] / src / main / java / eu / etaxonomy / cdm / vaadin / view / name / TaxonNamePopupEditorMode.java
1 /**
2 * Copyright (C) 2018 EDIT
3 * European Distributed Institute of Taxonomy
4 * http://www.e-taxonomy.eu
5 *
6 * The contents of this file are subject to the Mozilla Public License Version 1.1
7 * See LICENSE.TXT at the top of this package for the full license terms.
8 */
9 package eu.etaxonomy.cdm.vaadin.view.name;
10
11 /**
12 * @author a.kohlbecker
13 * @since Jan 11, 2018
14 *
15 */
16 public enum TaxonNamePopupEditorMode {
17
18 /**
19 * CombinationAuthorship BasionymAuthorship fields only visible if
20 * not empty
21 */
22 AUTOFILL_AUTHORSHIP_DATA,
23
24 /**
25 * Editing of the nomenclatural reference is limited to editing the sub section of the
26 * reference. Once the nomenclatural reference is set to a journal or book the user only can
27 * change it to a reference of type {@link eu.etaxonomy.cdm.model.reference.ReferenceType.#Section Section} which
28 * has the current reference as <code>inReference</code>. Whereas the book or journal can not be modified, the
29 * section can be edited via a ReferencePopupEditor.
30 */
31 NOMENCLATURALREFERENCE_SECTION_EDITING_ONLY,
32
33 /**
34 * setting the nomenclatural reference is required. This also accounts for names realted to the name
35 * being edites in the TaxonNamePopupEditor (basionyms, validation, replaced synonmys, ...).
36 */
37 REQUIRE_NOMENCLATURALREFERENCE,
38
39 /**
40 * The next higher name must be in the system or it needs to be entered. For species the next higher name is
41 * the genus, for sub-species it is the species, etc.
42 */
43 VALIDATE_AGAINST_HIGHER_NAME_PART,
44
45 /**
46 * The name relation type {@link eu.etaxonomy.cdm.model.name.NameRelationshipType#ORTHOGRAPHIC_VARIANT} will be treated more
47 * strictly if this mode is activated. The related name must have the same nomenclatural reference as the name being edited.
48 * see https://dev.e-taxonomy.eu/redmine/issues/7899 for more details.
49 *
50 * @deprecated see https://dev.e-taxonomy.eu/redmine/issues/7961
51 */
52 @Deprecated
53 ORTHOGRAPHIC_CORRECTION,
54
55 }