Package org.gbif.api.service.registry

Interface TagService

All Known Subinterfaces:
CollectionEntityService<T>, CollectionService, DatasetService, InstallationService, InstitutionService, NetworkEntityService<T>, NetworkService, NodeService, OrganizationService
public interface TagService
Service provides a set of operations on Tag.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    addTag(@NotNull UUID targetEntityKey, @NotNull @Valid Tag tag)
    Add a new Tag to a target entity.
    int
    addTag(@NotNull UUID targetEntityKey, @NotNull String value)
    Add a new Tag to a target entity.
    void
    deleteTag(@NotNull UUID taggedEntityKey, int tagKey)
    Delete an existing Tag from a tagged entity by tag key.
    List<Tag>
    listTags(@NotNull UUID taggedEntityKey, String owner)
    List all tags of a tagged entity.

  • Method Details

    • addTag

      int addTag(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull String value)
      Add a new Tag to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      value - Tag to add
      Returns:
      key of Tag added

    • addTag

      int addTag(@NotNull @NotNull UUID targetEntityKey, @NotNull @Valid @NotNull @Valid Tag tag)
      Add a new Tag to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      tag - Tag to add
      Returns:
      key of Tag added

    • deleteTag

      void deleteTag(@NotNull @NotNull UUID taggedEntityKey, int tagKey)
      Delete an existing Tag from a tagged entity by tag key.
      Parameters:
      taggedEntityKey - key of tagged entity
      tagKey - Tag key to delete

    • listTags

      List<Tag> listTags(@NotNull @NotNull UUID taggedEntityKey, @Nullable String owner)
      List all tags of a tagged entity.
      Parameters:
      taggedEntityKey - key of tagged entity
      owner - owner
      Returns:
      list of tags that belong to the entity and owner