Interface AssetConsumerTaggingInterface

  • All Known Implementing Classes:
    AssetConsumer

    public interface AssetConsumerTaggingInterface
    AssetConsumerTaggingInterface support the management and use of informal tags, whether public or private.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addTagToAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String tagGUID, boolean isPublic)
      Adds a tag (either private of public) to an asset.
      void addTagToElement​(java.lang.String userId, java.lang.String elementGUID, java.lang.String tagGUID, boolean isPublic)
      Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
      java.lang.String createPrivateTag​(java.lang.String userId, java.lang.String tagName, java.lang.String tagDescription)
      Creates a new private informal tag and returns the unique identifier for it.
      java.lang.String createPublicTag​(java.lang.String userId, java.lang.String tagName, java.lang.String tagDescription)
      Creates a new public informal tag and returns the unique identifier for it.
      void deleteTag​(java.lang.String userId, java.lang.String tagGUID)
      Removes a tag from the repository.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findMyTags​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of the calling user's private tags containing the supplied string in either the name or description.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findTags​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of tags containing the supplied string in either the name or description.
      java.util.List<java.lang.String> getAssetsByTag​(java.lang.String userId, java.lang.String tagGUID, int startFrom, int pageSize)
      Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getMyTagsByName​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of the calling user's private tags exactly matching the supplied name.
      org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement getTag​(java.lang.String userId, java.lang.String guid)
      Return the tag for the supplied unique identifier (guid).
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getTagsByName​(java.lang.String userId, java.lang.String tag, int startFrom, int pageSize)
      Return the list of tags exactly matching the supplied name.
      void removeTagFromAsset​(java.lang.String userId, java.lang.String assetGUID, java.lang.String tagGUID)
      Removes a tag from the asset that was added by this user.
      void removeTagFromElement​(java.lang.String userId, java.lang.String elementGUID, java.lang.String tagGUID)
      Removes a tag from an element attached to an asset - such as schema element, glossary term, ...
      void updateTagDescription​(java.lang.String userId, java.lang.String tagGUID, java.lang.String tagDescription)
      Updates the description of an existing tag (either private or public).
    • Method Detail

      • createPublicTag

        java.lang.String createPublicTag​(java.lang.String userId,
                                         java.lang.String tagName,
                                         java.lang.String tagDescription)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException
        Creates a new public informal tag and returns the unique identifier for it.
        Parameters:
        userId - userId of user making request.
        tagName - name of the tag.
        tagDescription - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
        Returns:
        GUID for new tag.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • createPrivateTag

        java.lang.String createPrivateTag​(java.lang.String userId,
                                          java.lang.String tagName,
                                          java.lang.String tagDescription)
                                   throws InvalidParameterException,
                                          PropertyServerException,
                                          UserNotAuthorizedException
        Creates a new private informal tag and returns the unique identifier for it.
        Parameters:
        userId - userId of user making request.
        tagName - name of the tag.
        tagDescription - (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
        Returns:
        GUID for new tag.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • updateTagDescription

        void updateTagDescription​(java.lang.String userId,
                                  java.lang.String tagGUID,
                                  java.lang.String tagDescription)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
        Updates the description of an existing tag (either private or public).
        Parameters:
        userId - userId of user making request.
        tagGUID - unique identifier for the tag.
        tagDescription - description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • getTagsByName

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getTagsByName​(java.lang.String userId,
                                                                                                                     java.lang.String tag,
                                                                                                                     int startFrom,
                                                                                                                     int pageSize)
                                                                                                              throws InvalidParameterException,
                                                                                                                     PropertyServerException,
                                                                                                                     UserNotAuthorizedException
        Return the list of tags exactly matching the supplied name.
        Parameters:
        userId - the name of the calling user.
        tag - name of tag.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        tag list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • getMyTagsByName

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> getMyTagsByName​(java.lang.String userId,
                                                                                                                       java.lang.String tag,
                                                                                                                       int startFrom,
                                                                                                                       int pageSize)
                                                                                                                throws InvalidParameterException,
                                                                                                                       PropertyServerException,
                                                                                                                       UserNotAuthorizedException
        Return the list of the calling user's private tags exactly matching the supplied name.
        Parameters:
        userId - the name of the calling user.
        tag - name of tag.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        tag list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • findTags

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findTags​(java.lang.String userId,
                                                                                                                java.lang.String tag,
                                                                                                                int startFrom,
                                                                                                                int pageSize)
                                                                                                         throws InvalidParameterException,
                                                                                                                PropertyServerException,
                                                                                                                UserNotAuthorizedException
        Return the list of tags containing the supplied string in either the name or description.
        Parameters:
        userId - the name of the calling user.
        tag - name of tag. This may include wild card characters.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        tag list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • findMyTags

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement> findMyTags​(java.lang.String userId,
                                                                                                                  java.lang.String tag,
                                                                                                                  int startFrom,
                                                                                                                  int pageSize)
                                                                                                           throws InvalidParameterException,
                                                                                                                  PropertyServerException,
                                                                                                                  UserNotAuthorizedException
        Return the list of the calling user's private tags containing the supplied string in either the name or description.
        Parameters:
        userId - the name of the calling user.
        tag - name of tag. This may include wild card characters.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        tag list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • addTagToAsset

        void addTagToAsset​(java.lang.String userId,
                           java.lang.String assetGUID,
                           java.lang.String tagGUID,
                           boolean isPublic)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException
        Adds a tag (either private of public) to an asset.
        Parameters:
        userId - userId of user making request.
        assetGUID - unique id for the asset.
        tagGUID - unique id of the tag.
        isPublic - flag indicating whether the attachment of the tag is public or not
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • addTagToElement

        void addTagToElement​(java.lang.String userId,
                             java.lang.String elementGUID,
                             java.lang.String tagGUID,
                             boolean isPublic)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException
        Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...
        Parameters:
        userId - userId of user making request.
        elementGUID - unique id for the element.
        tagGUID - unique id of the tag.
        isPublic - flag indicating whether the attachment of the tag is public or not
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem adding the asset properties to the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • removeTagFromElement

        void removeTagFromElement​(java.lang.String userId,
                                  java.lang.String elementGUID,
                                  java.lang.String tagGUID)
                           throws InvalidParameterException,
                                  PropertyServerException,
                                  UserNotAuthorizedException
        Removes a tag from an element attached to an asset - such as schema element, glossary term, ... that was added by this user.
        Parameters:
        userId - userId of user making request.
        elementGUID - unique id for the element.
        tagGUID - unique id for the tag.
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem updating the asset properties in the property server.
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • getAssetsByTag

        java.util.List<java.lang.String> getAssetsByTag​(java.lang.String userId,
                                                        java.lang.String tagGUID,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        PropertyServerException,
                                                        UserNotAuthorizedException
        Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements. An Asset's GUID may appear multiple times in the results if it is tagged multiple times with the requested tag.
        Parameters:
        userId - the name of the calling user.
        tagGUID - unique identifier of tag.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        asset guid list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.