Package org.ehrbase.api.service.experimental

Interface ItemTagService

public interface ItemTagService
Service manages the ITEM_TAG Class.
All operations on tags are implemented as bulk operations.

  • Method Details

    • bulkUpsert

      List<UUID> bulkUpsert(@Nonnull UUID ownerId, @Nonnull UUID targetId, @Nonnull ItemTagDto.ItemTagRMType targetType, @Nonnull List<ItemTagDto> itemTagsDto)
      Performs a bulk update/create operation for the given ItemTag into the tag list of the owner.
      Parameters:
      ownerId - Identifier of owner object, such as EHR.
      targetId - VERSIONED_OBJECT<T> Identifier of target.
      targetType - Type of the target object.
      itemTagsDto - Content of the ItemTag containing the key, value parameter.
      Returns:
      tagUUIDs of the update/create ItemTags

    • findItemTag

      List<ItemTagDto> findItemTag(@Nonnull UUID ownerId, @Nonnull UUID targetId, @Nonnull ItemTagDto.ItemTagRMType targetType, @Nonnull Collection<UUID> ids, @Nonnull Collection<String> keys)
      Performs a bulk get operation for the given ItemTag IDs and/or keys.
      Parameters:
      ownerId - Identifier of owner object, such as EHR.
      targetId - VERSIONED_OBJECT<T> Identifier of target.
      targetType - Type of the target object.
      ids - Identifier ItemTag to search for.
      keys - ItemTag keys to search for.
      Returns:
      tags Matching the ownerId, targetId and optional ids, keys

    • bulkDelete

      void bulkDelete(@Nonnull UUID ownerId, @Nonnull UUID targetId, @Nonnull ItemTagDto.ItemTagRMType targetType, @Nonnull Collection<UUID> ids)
      Performs a bulk delete operation for the given ItemTag ids. This method will simply return in cases where the given IDs does not exist.
      Parameters:
      ownerId - Identifier of owner object, such as EHR.
      targetId - VERSIONED_OBJECT<T> Identifier of target.
      targetType - Type of the target object.
      ids - Identifier ItemTag to delete.