001/*
002 * Licensed under the Apache License, Version 2.0 (the "License");
003 * you may not use this file except in compliance with the License.
004 * You may obtain a copy of the License at
005 *
006 *     http://www.apache.org/licenses/LICENSE-2.0
007 *
008 * Unless required by applicable law or agreed to in writing, software
009 * distributed under the License is distributed on an "AS IS" BASIS,
010 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
011 * See the License for the specific language governing permissions and
012 * limitations under the License.
013 */
014package org.gbif.api.vocabulary;
015
016import io.swagger.v3.oas.annotations.ExternalDocumentation;
017import io.swagger.v3.oas.annotations.media.Schema;
018
019/**
020 * A simple enumeration of all DarwinCore values of BasisOfRecord legal for occurrences.
021 *
022 * @see <a href="https://rs.gbif.org/vocabulary/dwc/basis_of_record.xml">GBIF Vocabulary</a>
023 */
024@Schema(
025  description = "The values of the Darwin Core term Basis of Record which can apply to occurrences.\n\n" +
026    "See GBIF's [Darwin Core Type Vocabulary](https://rs.gbif.org/vocabulary/dwc/basis_of_record.xml) for definitions.",
027  externalDocs = @ExternalDocumentation(
028    description = "API call to retrieve all official values.",
029    url = "https://api.gbif.org/v1/enumeration/basic/BasisOfRecord"
030  )
031)
032public enum BasisOfRecord {
033
034  /**
035   * An occurrence record describing a preserved specimen.
036   */
037  PRESERVED_SPECIMEN,
038
039  /**
040   * An occurrence record describing a fossilized specimen.
041   */
042  FOSSIL_SPECIMEN,
043
044  /**
045   * An occurrence record describing a living specimen, e.g. managed animals in a zoo
046   * or cultivated plants in a garden.
047   */
048  LIVING_SPECIMEN,
049
050  /**
051   * An occurrence record describing an observation.
052   */
053  OBSERVATION,
054
055  /**
056   * An occurrence record describing an observation made by one or more people.
057   */
058  HUMAN_OBSERVATION,
059
060  /**
061   * An occurrence record describing an observation made by a machine.
062   */
063  MACHINE_OBSERVATION,
064
065  /**
066   * An occurrence record based on samples taken from other specimens or the environment.
067   */
068  MATERIAL_SAMPLE,
069
070  /**
071   * An occurrence record based on literature alone.
072   * @deprecated use BasisOfRecord.OCCURRENCE instead.
073   */
074  @Deprecated
075  LITERATURE,
076
077  /**
078   * A reference to or citation of one, a part of, or multiple specimens in scholarly publications.
079   */
080  MATERIAL_CITATION,
081
082  /**
083   * An existence of an Organism (sensu http://rs.tdwg.org/dwc/terms/Organism) at a particular place at a particular time.
084   */
085  OCCURRENCE,
086
087  /**
088   * Unknown basis for the record.
089   * @deprecated replaced by BasisOfRecord.OCCURRENCE.
090   */
091  @Deprecated
092  UNKNOWN
093
094}