Package org.gbif.api.service.checklistbank

Interface DescriptionService

All Superinterfaces:
NameUsageExtensionService<Description>
public interface DescriptionService extends NameUsageExtensionService<Description>
Service interface for Description Interface methods. This is the public interface providing methods for retrieving Description. These methods will for the most part return a Description object.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Description
    get(int key)
    Retrieve a description by its key.
    TableOfContents
    getToc(int taxonKey)
    Returns a table of content for all available descriptions of a name usage.

    Methods inherited from interface org.gbif.api.service.checklistbank.NameUsageExtensionService

    listByUsage

  • Method Details

    • getToc

      TableOfContents getToc(int taxonKey)
      Returns a table of content for all available descriptions of a name usage.
      Parameters:
      taxonKey - the name usage key

    • get

      @Nullable Description get(int key)
      Retrieve a description by its key. The portal species pages rely on this method to asynchroneously load species descriptions.
      Parameters:
      key - that identifies a description