Interface TagApi


  • public interface TagApi
    Contains all api operations for handling tags.
    • Method Detail

      • getTag

        Tag getTag​(UUID tagId)
        Returns a tag identified by given id.
        Parameters:
        tagId - the id of the tag
        Returns:
        the tag
      • getTagsByAssetId

        @SecurityAuditMethod(resultFormatter=com.collibra.audit.formatter.CollectionFormatter.class)
        List<Tag> getTagsByAssetId​(UUID assetId)
        Retrieves all tags of given asset.
        Parameters:
        assetId - The id of an asset
        Returns:
        tags of given asset
      • changeTag

        Tag changeTag​(ChangeTagRequest changeTagRequest)
        Changes a tag.
        Parameters:
        changeTagRequest - the information required to be able to change the tag
        Returns:
        the modified tag
      • removeTag

        void removeTag​(UUID tagId)
        Remove a tag.
        Parameters:
        tagId - Id of the tag to be removed.
      • removeTags

        void removeTags​(List<UUID> tagsIds)
        Removes the tags identified by given ids.
        Parameters:
        tagsIds - the ids of the tags to remove
      • mergeTags

        void mergeTags​(MergeTagsRequest mergeTagsRequest)
        Merge two tags into one. All assets which has been tagged by tag with id 'fromId' will be tagged by tag with id 'toId'. Tag with id 'fromId' will be removed.
        Parameters:
        mergeTagsRequest - contains "fromId" and "toId" of the tags
      • exists

        boolean exists​(UUID tagId)
        Returns true if a tag with given id exists.
        Parameters:
        tagId - the id of the tag
        Returns:
        true if a tag with given id exists, false otherwise
      • exists

        boolean exists​(String tagName)
        Returns true if a tag with given name exists.
        Parameters:
        tagName - the name of the tag
        Returns:
        true if a tag with given tagName exists, false otherwise