Package org.gbif.api.service.registry

Interface MachineTagService

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

  • Method Details

    • addMachineTag

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

    • addMachineTag

      int addMachineTag(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull TagName tagName, @NotNull @NotNull String value)
      Add a new MachineTag to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      tagName - TagName
      value - tag value to add
      Returns:
      key of tag added

    • addMachineTag

      int addMachineTag(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull String namespace, @NotNull @NotNull String name, @NotNull @NotNull String value)
      Add a new MachineTag to a target entity.
      Parameters:
      targetEntityKey - key of target entity
      namespace - tag namespace
      name - name of the tag to add
      value - value of the tag to add
      Returns:
      key of tag added

    • deleteMachineTag

      void deleteMachineTag(@NotNull @NotNull UUID targetEntityKey, int machineTagKey)
      Delete an existing MachineTag from a tagged entity by tag key.
      Parameters:
      targetEntityKey - key of tagged entity
      machineTagKey - key of the tag to delete

    • deleteMachineTags

      void deleteMachineTags(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull TagNamespace tagNamespace)
      Delete machine tags from a tagged entity by tag namespace.
      Parameters:
      targetEntityKey - key of tagged entity
      tagNamespace - TagNamespace

    • deleteMachineTags

      void deleteMachineTags(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull String namespace)
      Delete machine tags from a tagged entity by tag namespace.
      Parameters:
      targetEntityKey - key of tagged entity
      namespace - tag namespace

    • deleteMachineTags

      void deleteMachineTags(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull TagName tagName)
      Delete machine tags from a tagged entity by tag name.
      Parameters:
      targetEntityKey - key of tagged entity
      tagName - TagName

    • deleteMachineTags

      void deleteMachineTags(@NotNull @NotNull UUID targetEntityKey, @NotNull @NotNull String namespace, @NotNull @NotNull String name)
      Delete machine tags from a tagged entity by namespace and tag name.
      Parameters:
      targetEntityKey - key of tagged entity
      namespace - tag namespace
      name - TagName

    • listMachineTags

      List<MachineTag> listMachineTags(@NotNull @NotNull UUID targetEntityKey)
      List all machine tags of the entity.
      Parameters:
      targetEntityKey - key of the entity
      Returns:
      list of tags that belong to the entity