Interface ClientTagManager

    • Method Detail

      • getClientTagProvider

        ClientTagProvider getClientTagProvider​(java.lang.String provider)
      • getProviderProperties

        java.util.List<TagProviderProps> getProviderProperties()
      • getProviderProperties

        TagProviderProps getProviderProperties​(java.lang.String provider)
      • isAncestorOf

        boolean isAncestorOf​(TagPath baseTypeId,
                             TagPath potentialSubTypeId)
        Returns true if the second argument is equal to or subtype of the first argument.
      • requestTagGroupExecution

        void requestTagGroupExecution​(java.lang.String provider,
                                      java.lang.String tagGroup)
                               throws java.lang.Exception
        Throws:
        java.lang.Exception
      • copyTagsToClipboard

        void copyTagsToClipboard​(java.util.List<TagPath> tagPaths,
                                 boolean removeOriginalTags)
      • pasteFromClipboard

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> pasteFromClipboard​(TagPath destination)
      • getTagConfigsAsync

        java.util.concurrent.CompletableFuture<java.util.List<TagConfigurationModel>> getTagConfigsAsync​(java.util.List<TagPath> tagPaths,
                                                                                                         boolean recursive,
                                                                                                         boolean localPropsOnly)
      • removeTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> removeTagsAsync​(java.util.List<TagPath> tagPaths,
                                                                                            SecurityContext securityContext)
      • importTagDataSourcesAsync

        java.util.concurrent.CompletableFuture<QualityCode> importTagDataSourcesAsync​(TagPath location,
                                                                                      java.util.List<BrowseElement> elements)
      • reinitializeTagsAsync

        java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> reinitializeTagsAsync​(java.util.List<TagPath> tagPaths)
      • getValueChangeMetric

        StatMetric getValueChangeMetric()
      • renameTagAsync

        default java.util.concurrent.CompletableFuture<QualityCode> renameTagAsync​(TagPath tag,
                                                                                   java.lang.String newName,
                                                                                   CollisionPolicy collisionPolicy)
      • importTagsAsync

        default java.util.concurrent.CompletableFuture<java.util.List<QualityCode>> importTagsAsync​(TagPath basePath,
                                                                                                    java.lang.String importText,
                                                                                                    java.lang.String importType,
                                                                                                    CollisionPolicy collisionPolicy,
                                                                                                    SecurityContext securityContext)
        Specified by:
        importTagsAsync in interface TagManager
        Parameters:
        basePath - tags will be imported using this location as the base. The provider source must be set.
        importText - a String holding the contents of the file to import
        importType - The import file type. Use "json", "xml" or "csv". Any other value will return an error.
        collisionPolicy - The collision policy to use. Abort will throw an exception on the first tag collision, Ignore will not change the existing tag at all, Overwrite will overwrite the existing tag completely, and Rename will create a new tag with a similar name (MyTag becomes MyTag1).
        securityContext - the SecurityContext of the user from the call site