Class GlossaryExchangeClient

    • Constructor Summary

      Constructors 
      Constructor Description
      GlossaryExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      GlossaryExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      GlossaryExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      GlossaryExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server.
      GlossaryExchangeClient​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void attachExternalCategoryLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryCategoryGUID, ExternalGlossaryElementLinkProperties linkProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Create a link to an external glossary category resource.
      void attachExternalLinkToGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Connect a glossary to a reference to an external glossary resource.
      void attachExternalTermLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryTermGUID, ExternalGlossaryElementLinkProperties linkProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Create a link to an external glossary term resource.
      void clearCategoryParent​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryParentCategoryGUID, java.lang.String glossaryChildCategoryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove a parent-child relationship between two categories.
      void clearGlossaryAsCanonical​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier)
      Remove the canonical designation from the glossary.
      void clearGlossaryAsTaxonomy​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier)
      Remove the taxonomy designation from the glossary.
      void clearTermAsAbstractConcept​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the abstract concept designation from the glossary term.
      void clearTermAsActivity​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the activity designation from the glossary term.
      void clearTermAsContext​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the context definition designation from the glossary term.
      void clearTermAsDataValue​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the data value designation from the glossary term.
      void clearTermAsObjectIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the object identifier designation from the glossary term.
      void clearTermAsSpineAttribute​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the spine attribute designation from the glossary term.
      void clearTermAsSpineObject​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the spine object designation from the glossary term.
      void clearTermCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.lang.String glossaryTermGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Unlink a term from a category.
      void clearTermRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String glossaryTermOneGUID, java.lang.String glossaryTermTwoGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the relationship between two terms.
      java.lang.String createControlledGlossaryTerm​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryTermProperties glossaryTermProperties, GlossaryTermStatus initialStatus)
      Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
      java.lang.String createExternalGlossaryLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, ExternalGlossaryLinkProperties linkProperties)
      Create a link to an external glossary resource.
      java.lang.String createGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, ExternalIdentifierProperties externalIdentifierProperties, GlossaryProperties glossaryProperties)
      Create a new metadata element to represent the root of a glossary.
      java.lang.String createGlossaryCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryCategoryProperties glossaryCategoryProperties)
      Create a new metadata element to represent a glossary category.
      java.lang.String createGlossaryCategoryFromTemplate​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent a glossary category using an existing metadata element as a template.
      java.lang.String createGlossaryFromTemplate​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent a glossary using an existing metadata element as a template.
      java.lang.String createGlossaryTerm​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryTermProperties glossaryTermProperties)
      Create a new metadata element to represent a glossary term.
      java.lang.String createGlossaryTermFromTemplate​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)
      Create a new metadata element to represent a glossary term using an existing metadata element as a template.
      void detachExternalCategoryLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryCategoryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the link to an external glossary category resource.
      void detachExternalLinkFromGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Disconnect a glossary from a reference to an external glossary resource.
      void detachExternalTermLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.lang.String glossaryTermGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the link to an external glossary term resource.
      java.util.List<GlossaryElement> findGlossaries​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of glossary metadata elements that contain the search string.
      java.util.List<GlossaryCategoryElement> findGlossaryCategories​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary category metadata elements that contain the search string.
      java.util.List<GlossaryTermElement> findGlossaryTerms​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String searchString, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary term metadata elements that contain the search string.
      java.util.List<GlossaryCategoryElement> getCategoriesForGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Return the list of categories associated with a glossary.
      java.util.List<ExternalGlossaryLinkElement> getExternalLinksForGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of links to external glossary resources attached to a glossary.
      java.util.List<GlossaryElement> getGlossariesByName​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of glossary metadata elements with a matching qualified or display name.
      java.util.List<GlossaryElement> getGlossariesForAssetManager​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, int startFrom, int pageSize)
      Retrieve the list of glossaries created on behalf of the named asset manager.
      java.util.List<GlossaryElement> getGlossariesForExternalLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Return the glossaries connected to an external glossary source.
      GlossaryElement getGlossaryByGUID​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String guid)
      Retrieve the glossary metadata element with the supplied unique identifier.
      java.util.List<GlossaryCategoryElement> getGlossaryCategoriesByName​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary category metadata elements with a matching qualified or display name.
      GlossaryCategoryElement getGlossaryCategoryByGUID​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      GlossaryCategoryElement getGlossaryCategoryParent​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      java.util.List<GlossaryCategoryElement> getGlossarySubCategories​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the glossary category metadata element with the supplied unique identifier.
      GlossaryTermElement getGlossaryTermByGUID​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the glossary term metadata element with the supplied unique identifier.
      java.util.List<GlossaryTermElement> getGlossaryTermsByName​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String name, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary term metadata elements with a matching qualified or display name.
      java.util.List<GlossaryTermElement> getTermsForGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary terms associated with a glossary.
      java.util.List<GlossaryTermElement> getTermsForGlossaryCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, int startFrom, int pageSize, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Retrieve the list of glossary terms associated with a glossary category.
      void removeExternalGlossaryLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
      void removeGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier)
      Remove the metadata element representing a glossary.
      void removeGlossaryCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.lang.String glossaryCategoryExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the metadata element representing a glossary category.
      void removeGlossaryTerm​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Remove the metadata element representing a glossary term.
      void setGlossaryAsCanonical​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier, java.lang.String scope)
      Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.
      void setGlossaryAsTaxonomy​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier, java.lang.String organizingPrinciple)
      Classify the glossary to indicate that it can be used as a taxonomy.
      void setTermAsAbstractConcept​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes an abstract concept.
      void setTermAsActivity​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, GlossaryTermActivityType activityType, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes a data value.
      void setTermAsContext​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, GlossaryTermContextDefinition contextDefinition, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes a context.
      void setTermAsDataValue​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes a data value.
      void setTermAsObjectIdentifier​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes an object identifier.
      void setTermAsSpineAttribute​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes a spine attribute.
      void setTermAsSpineObject​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Classify the glossary term to indicate that it describes a spine object.
      void setupCategoryParent​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryParentCategoryGUID, java.lang.String glossaryChildCategoryGUID, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Create a parent-child relationship between two categories.
      void setupTermCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.lang.String glossaryTermGUID, GlossaryTermCategorization categorizationProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Link a term to a category.
      void setupTermRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String glossaryTermOneGUID, java.lang.String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Link two terms together using a specialist relationship.
      void updateExternalGlossaryLink​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String externalLinkGUID, boolean isMergeUpdate, ExternalGlossaryLinkProperties linkProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the properties of a reference to an external glossary resource.
      void updateGlossary​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryGUID, java.lang.String glossaryExternalIdentifier, GlossaryProperties glossaryProperties)
      Update the metadata element representing a glossary.
      void updateGlossaryCategory​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryCategoryGUID, java.lang.String glossaryCategoryExternalIdentifier, boolean isMergeUpdate, GlossaryCategoryProperties glossaryCategoryProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the metadata element representing a glossary category.
      void updateGlossaryTerm​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, boolean isMergeUpdate, GlossaryTermProperties glossaryTermProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the metadata element representing a glossary term.
      void updateGlossaryTermStatus​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String glossaryTermGUID, java.lang.String glossaryTermExternalIdentifier, GlossaryTermStatus glossaryTermStatus, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the status of the metadata element representing a glossary term.
      void updateTermRelationship​(java.lang.String userId, java.lang.String assetManagerGUID, java.lang.String assetManagerName, java.lang.String relationshipTypeName, java.lang.String glossaryTermOneGUID, java.lang.String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties, java.util.Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
      Update the relationship properties for the two terms.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • GlossaryExchangeClient

        public GlossaryExchangeClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      AuditLog auditLog)
                               throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • GlossaryExchangeClient

        public GlossaryExchangeClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot)
                               throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • GlossaryExchangeClient

        public GlossaryExchangeClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password,
                                      AuditLog auditLog)
                               throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • GlossaryExchangeClient

        public GlossaryExchangeClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      AssetManagerRESTClient restClient,
                                      int maxPageSize,
                                      AuditLog auditLog)
                               throws InvalidParameterException
        Create a new client that is going to be used in an OMAG Server.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - client that issues the REST API calls
        maxPageSize - maximum number of results supported by this server
        auditLog - logging destination
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
      • GlossaryExchangeClient

        public GlossaryExchangeClient​(java.lang.String serverName,
                                      java.lang.String serverPlatformURLRoot,
                                      java.lang.String userId,
                                      java.lang.String password)
                               throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
    • Method Detail

      • createGlossary

        public java.lang.String createGlossary​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               ExternalIdentifierProperties externalIdentifierProperties,
                                               GlossaryProperties glossaryProperties)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Create a new metadata element to represent the root of a glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
        Specified by:
        createGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalIdentifierProperties - optional properties used to define an external identifier
        glossaryProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createGlossaryFromTemplate

        public java.lang.String createGlossaryFromTemplate​(java.lang.String userId,
                                                           java.lang.String assetManagerGUID,
                                                           java.lang.String assetManagerName,
                                                           java.lang.String templateGUID,
                                                           ExternalIdentifierProperties externalIdentifierProperties,
                                                           TemplateProperties templateProperties)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
        Specified by:
        createGlossaryFromTemplate in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        externalIdentifierProperties - optional properties used to define an external identifier
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateGlossary

        public void updateGlossary​(java.lang.String userId,
                                   java.lang.String assetManagerGUID,
                                   java.lang.String assetManagerName,
                                   java.lang.String glossaryGUID,
                                   java.lang.String glossaryExternalIdentifier,
                                   GlossaryProperties glossaryProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Update the metadata element representing a glossary.
        Specified by:
        updateGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to update
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        glossaryProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setGlossaryAsTaxonomy

        public void setGlossaryAsTaxonomy​(java.lang.String userId,
                                          java.lang.String assetManagerGUID,
                                          java.lang.String assetManagerName,
                                          java.lang.String glossaryGUID,
                                          java.lang.String glossaryExternalIdentifier,
                                          java.lang.String organizingPrinciple)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Classify the glossary to indicate that it can be used as a taxonomy. This means each term is attached to one, and only one category and the categories are organized as a hierarchy with a single root category. Taxonomies are used as a way of organizing assets and other related metadata. The terms in the taxonomy are linked to the assets etc. and as such they are logically categorized by the linked category.
        Specified by:
        setGlossaryAsTaxonomy in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to remove
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        organizingPrinciple - description of how the glossary is organized
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearGlossaryAsTaxonomy

        public void clearGlossaryAsTaxonomy​(java.lang.String userId,
                                            java.lang.String assetManagerGUID,
                                            java.lang.String assetManagerName,
                                            java.lang.String glossaryGUID,
                                            java.lang.String glossaryExternalIdentifier)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Remove the taxonomy designation from the glossary.
        Specified by:
        clearGlossaryAsTaxonomy in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to remove
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setGlossaryAsCanonical

        public void setGlossaryAsCanonical​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String glossaryGUID,
                                           java.lang.String glossaryExternalIdentifier,
                                           java.lang.String scope)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name. This means there is only one definition for each term. Typically, the terms are also of a similar level of granularity and are limited to a specific scope of use. Canonical vocabularies are used to semantically classify assets in an unambiguous way.
        Specified by:
        setGlossaryAsCanonical in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to remove
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        scope - description of the situations where this glossary is relevant.
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearGlossaryAsCanonical

        public void clearGlossaryAsCanonical​(java.lang.String userId,
                                             java.lang.String assetManagerGUID,
                                             java.lang.String assetManagerName,
                                             java.lang.String glossaryGUID,
                                             java.lang.String glossaryExternalIdentifier)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Remove the canonical designation from the glossary.
        Specified by:
        clearGlossaryAsCanonical in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to remove
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeGlossary

        public void removeGlossary​(java.lang.String userId,
                                   java.lang.String assetManagerGUID,
                                   java.lang.String assetManagerName,
                                   java.lang.String glossaryGUID,
                                   java.lang.String glossaryExternalIdentifier)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.
        Specified by:
        removeGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the metadata element to remove
        glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • findGlossaries

        public java.util.List<GlossaryElement> findGlossaries​(java.lang.String userId,
                                                              java.lang.String assetManagerGUID,
                                                              java.lang.String assetManagerName,
                                                              java.lang.String searchString,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException
        Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.
        Specified by:
        findGlossaries in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned*
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossariesByName

        public java.util.List<GlossaryElement> getGlossariesByName​(java.lang.String userId,
                                                                   java.lang.String assetManagerGUID,
                                                                   java.lang.String assetManagerName,
                                                                   java.lang.String name,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Specified by:
        getGlossariesByName in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createGlossaryCategory

        public java.lang.String createGlossaryCategory​(java.lang.String userId,
                                                       java.lang.String assetManagerGUID,
                                                       java.lang.String assetManagerName,
                                                       java.lang.String glossaryGUID,
                                                       ExternalIdentifierProperties externalIdentifierProperties,
                                                       GlossaryCategoryProperties glossaryCategoryProperties)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
        Create a new metadata element to represent a glossary category.
        Specified by:
        createGlossaryCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the glossary where the category is located
        externalIdentifierProperties - optional properties used to define an external identifier
        glossaryCategoryProperties - properties about the glossary category to store
        Returns:
        unique identifier of the new glossary category
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createGlossaryCategoryFromTemplate

        public java.lang.String createGlossaryCategoryFromTemplate​(java.lang.String userId,
                                                                   java.lang.String assetManagerGUID,
                                                                   java.lang.String assetManagerName,
                                                                   java.lang.String templateGUID,
                                                                   ExternalIdentifierProperties externalIdentifierProperties,
                                                                   TemplateProperties templateProperties)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Create a new metadata element to represent a glossary category using an existing metadata element as a template.
        Specified by:
        createGlossaryCategoryFromTemplate in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        externalIdentifierProperties - optional properties used to define an external identifier
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new glossary category
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateGlossaryCategory

        public void updateGlossaryCategory​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String glossaryCategoryGUID,
                                           java.lang.String glossaryCategoryExternalIdentifier,
                                           boolean isMergeUpdate,
                                           GlossaryCategoryProperties glossaryCategoryProperties,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Update the metadata element representing a glossary category.
        Specified by:
        updateGlossaryCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the metadata element to update
        glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        glossaryCategoryProperties - new properties for the metadata element
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupCategoryParent

        public void setupCategoryParent​(java.lang.String userId,
                                        java.lang.String assetManagerGUID,
                                        java.lang.String assetManagerName,
                                        java.lang.String glossaryParentCategoryGUID,
                                        java.lang.String glossaryChildCategoryGUID,
                                        java.util.Date effectiveTime,
                                        boolean forLineage,
                                        boolean forDuplicateProcessing)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Create a parent-child relationship between two categories.
        Specified by:
        setupCategoryParent in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category
        glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearCategoryParent

        public void clearCategoryParent​(java.lang.String userId,
                                        java.lang.String assetManagerGUID,
                                        java.lang.String assetManagerName,
                                        java.lang.String glossaryParentCategoryGUID,
                                        java.lang.String glossaryChildCategoryGUID,
                                        java.util.Date effectiveTime,
                                        boolean forLineage,
                                        boolean forDuplicateProcessing)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Remove a parent-child relationship between two categories.
        Specified by:
        clearCategoryParent in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category
        glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeGlossaryCategory

        public void removeGlossaryCategory​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String glossaryCategoryGUID,
                                           java.lang.String glossaryCategoryExternalIdentifier,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the metadata element representing a glossary category.
        Specified by:
        removeGlossaryCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the metadata element to remove
        glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • findGlossaryCategories

        public java.util.List<GlossaryCategoryElement> findGlossaryCategories​(java.lang.String userId,
                                                                              java.lang.String assetManagerGUID,
                                                                              java.lang.String assetManagerName,
                                                                              java.lang.String searchString,
                                                                              int startFrom,
                                                                              int pageSize,
                                                                              java.util.Date effectiveTime,
                                                                              boolean forLineage,
                                                                              boolean forDuplicateProcessing)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException
        Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.
        Specified by:
        findGlossaryCategories in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getCategoriesForGlossary

        public java.util.List<GlossaryCategoryElement> getCategoriesForGlossary​(java.lang.String userId,
                                                                                java.lang.String assetManagerGUID,
                                                                                java.lang.String assetManagerName,
                                                                                java.lang.String glossaryGUID,
                                                                                int startFrom,
                                                                                int pageSize,
                                                                                java.util.Date effectiveTime,
                                                                                boolean forLineage,
                                                                                boolean forDuplicateProcessing)
                                                                         throws InvalidParameterException,
                                                                                UserNotAuthorizedException,
                                                                                PropertyServerException
        Return the list of categories associated with a glossary.
        Specified by:
        getCategoriesForGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the glossary to query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of metadata elements describing the categories associated with the requested glossary
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossaryCategoriesByName

        public java.util.List<GlossaryCategoryElement> getGlossaryCategoriesByName​(java.lang.String userId,
                                                                                   java.lang.String assetManagerGUID,
                                                                                   java.lang.String assetManagerName,
                                                                                   java.lang.String name,
                                                                                   int startFrom,
                                                                                   int pageSize,
                                                                                   java.util.Date effectiveTime,
                                                                                   boolean forLineage,
                                                                                   boolean forDuplicateProcessing)
                                                                            throws InvalidParameterException,
                                                                                   UserNotAuthorizedException,
                                                                                   PropertyServerException
        Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Specified by:
        getGlossaryCategoriesByName in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossaryCategoryByGUID

        public GlossaryCategoryElement getGlossaryCategoryByGUID​(java.lang.String userId,
                                                                 java.lang.String assetManagerGUID,
                                                                 java.lang.String assetManagerName,
                                                                 java.lang.String glossaryCategoryGUID,
                                                                 java.util.Date effectiveTime,
                                                                 boolean forLineage,
                                                                 boolean forDuplicateProcessing)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException
        Retrieve the glossary category metadata element with the supplied unique identifier.
        Specified by:
        getGlossaryCategoryByGUID in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the requested metadata element
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        requested metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossaryCategoryParent

        public GlossaryCategoryElement getGlossaryCategoryParent​(java.lang.String userId,
                                                                 java.lang.String assetManagerGUID,
                                                                 java.lang.String assetManagerName,
                                                                 java.lang.String glossaryCategoryGUID,
                                                                 java.util.Date effectiveTime,
                                                                 boolean forLineage,
                                                                 boolean forDuplicateProcessing)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException
        Retrieve the glossary category metadata element with the supplied unique identifier.
        Specified by:
        getGlossaryCategoryParent in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the requested metadata element
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        parent glossary category element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossarySubCategories

        public java.util.List<GlossaryCategoryElement> getGlossarySubCategories​(java.lang.String userId,
                                                                                java.lang.String assetManagerGUID,
                                                                                java.lang.String assetManagerName,
                                                                                java.lang.String glossaryCategoryGUID,
                                                                                int startFrom,
                                                                                int pageSize,
                                                                                java.util.Date effectiveTime,
                                                                                boolean forLineage,
                                                                                boolean forDuplicateProcessing)
                                                                         throws InvalidParameterException,
                                                                                UserNotAuthorizedException,
                                                                                PropertyServerException
        Retrieve the glossary category metadata element with the supplied unique identifier.
        Specified by:
        getGlossarySubCategories in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the requested metadata element
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of glossary category element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createGlossaryTerm

        public java.lang.String createGlossaryTerm​(java.lang.String userId,
                                                   java.lang.String assetManagerGUID,
                                                   java.lang.String assetManagerName,
                                                   java.lang.String glossaryGUID,
                                                   ExternalIdentifierProperties externalIdentifierProperties,
                                                   GlossaryTermProperties glossaryTermProperties)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Create a new metadata element to represent a glossary term.
        Specified by:
        createGlossaryTerm in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the glossary where the term is located
        externalIdentifierProperties - optional properties used to define an external identifier
        glossaryTermProperties - properties for the glossary term
        Returns:
        unique identifier of the new metadata element for the glossary term
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createControlledGlossaryTerm

        public java.lang.String createControlledGlossaryTerm​(java.lang.String userId,
                                                             java.lang.String assetManagerGUID,
                                                             java.lang.String assetManagerName,
                                                             java.lang.String glossaryGUID,
                                                             ExternalIdentifierProperties externalIdentifierProperties,
                                                             GlossaryTermProperties glossaryTermProperties,
                                                             GlossaryTermStatus initialStatus)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
        Specified by:
        createControlledGlossaryTerm in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the glossary where the term is located
        externalIdentifierProperties - optional properties used to define an external identifier
        glossaryTermProperties - properties for the glossary term
        initialStatus - glossary term status to use when the object is created
        Returns:
        unique identifier of the new metadata element for the glossary term
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createGlossaryTermFromTemplate

        public java.lang.String createGlossaryTermFromTemplate​(java.lang.String userId,
                                                               java.lang.String assetManagerGUID,
                                                               java.lang.String assetManagerName,
                                                               java.lang.String templateGUID,
                                                               ExternalIdentifierProperties externalIdentifierProperties,
                                                               TemplateProperties templateProperties)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException
        Create a new metadata element to represent a glossary term using an existing metadata element as a template.
        Specified by:
        createGlossaryTermFromTemplate in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        externalIdentifierProperties - optional properties used to define an external identifier
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element for the glossary term
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateGlossaryTerm

        public void updateGlossaryTerm​(java.lang.String userId,
                                       java.lang.String assetManagerGUID,
                                       java.lang.String assetManagerName,
                                       java.lang.String glossaryTermGUID,
                                       java.lang.String glossaryTermExternalIdentifier,
                                       boolean isMergeUpdate,
                                       GlossaryTermProperties glossaryTermProperties,
                                       java.util.Date effectiveTime,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Update the metadata element representing a glossary term.
        Specified by:
        updateGlossaryTerm in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the glossary term to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        glossaryTermProperties - new properties for the glossary term
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateGlossaryTermStatus

        public void updateGlossaryTermStatus​(java.lang.String userId,
                                             java.lang.String assetManagerGUID,
                                             java.lang.String assetManagerName,
                                             java.lang.String glossaryTermGUID,
                                             java.lang.String glossaryTermExternalIdentifier,
                                             GlossaryTermStatus glossaryTermStatus,
                                             java.util.Date effectiveTime,
                                             boolean forLineage,
                                             boolean forDuplicateProcessing)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.
        Specified by:
        updateGlossaryTermStatus in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the glossary term to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        glossaryTermStatus - new properties for the glossary term
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupTermCategory

        public void setupTermCategory​(java.lang.String userId,
                                      java.lang.String assetManagerGUID,
                                      java.lang.String assetManagerName,
                                      java.lang.String glossaryCategoryGUID,
                                      java.lang.String glossaryTermGUID,
                                      GlossaryTermCategorization categorizationProperties,
                                      java.util.Date effectiveTime,
                                      boolean forLineage,
                                      boolean forDuplicateProcessing)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Link a term to a category.
        Specified by:
        setupTermCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the glossary category
        glossaryTermGUID - unique identifier of the glossary term
        categorizationProperties - properties for the categorization relationship
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermCategory

        public void clearTermCategory​(java.lang.String userId,
                                      java.lang.String assetManagerGUID,
                                      java.lang.String assetManagerName,
                                      java.lang.String glossaryCategoryGUID,
                                      java.lang.String glossaryTermGUID,
                                      java.util.Date effectiveTime,
                                      boolean forLineage,
                                      boolean forDuplicateProcessing)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Unlink a term from a category.
        Specified by:
        clearTermCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the glossary category
        glossaryTermGUID - unique identifier of the glossary term
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupTermRelationship

        public void setupTermRelationship​(java.lang.String userId,
                                          java.lang.String assetManagerGUID,
                                          java.lang.String assetManagerName,
                                          java.lang.String relationshipTypeName,
                                          java.lang.String glossaryTermOneGUID,
                                          java.lang.String glossaryTermTwoGUID,
                                          GlossaryTermRelationship relationshipsProperties,
                                          java.util.Date effectiveTime,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Link two terms together using a specialist relationship.
        Specified by:
        setupTermRelationship in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        relationshipTypeName - name of the type of relationship to create
        glossaryTermOneGUID - unique identifier of the glossary term at end 1
        glossaryTermTwoGUID - unique identifier of the glossary term at end 2
        relationshipsProperties - properties for the relationship
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateTermRelationship

        public void updateTermRelationship​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String relationshipTypeName,
                                           java.lang.String glossaryTermOneGUID,
                                           java.lang.String glossaryTermTwoGUID,
                                           GlossaryTermRelationship relationshipsProperties,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Update the relationship properties for the two terms.
        Specified by:
        updateTermRelationship in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        relationshipTypeName - name of the type of relationship to create
        glossaryTermOneGUID - unique identifier of the glossary term at end 1
        glossaryTermTwoGUID - unique identifier of the glossary term at end 2
        relationshipsProperties - properties for the relationship
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermRelationship

        public void clearTermRelationship​(java.lang.String userId,
                                          java.lang.String assetManagerGUID,
                                          java.lang.String assetManagerName,
                                          java.lang.String relationshipTypeName,
                                          java.lang.String glossaryTermOneGUID,
                                          java.lang.String glossaryTermTwoGUID,
                                          java.util.Date effectiveTime,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the relationship between two terms.
        Specified by:
        clearTermRelationship in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        relationshipTypeName - name of the type of relationship to create
        glossaryTermOneGUID - unique identifier of the glossary term at end 1
        glossaryTermTwoGUID - unique identifier of the glossary term at end 2
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsAbstractConcept

        public void setTermAsAbstractConcept​(java.lang.String userId,
                                             java.lang.String assetManagerGUID,
                                             java.lang.String assetManagerName,
                                             java.lang.String glossaryTermGUID,
                                             java.lang.String glossaryTermExternalIdentifier,
                                             java.util.Date effectiveTime,
                                             boolean forLineage,
                                             boolean forDuplicateProcessing)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Classify the glossary term to indicate that it describes an abstract concept.
        Specified by:
        setTermAsAbstractConcept in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsAbstractConcept

        public void clearTermAsAbstractConcept​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               java.lang.String glossaryTermGUID,
                                               java.lang.String glossaryTermExternalIdentifier,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Remove the abstract concept designation from the glossary term.
        Specified by:
        clearTermAsAbstractConcept in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsDataValue

        public void setTermAsDataValue​(java.lang.String userId,
                                       java.lang.String assetManagerGUID,
                                       java.lang.String assetManagerName,
                                       java.lang.String glossaryTermGUID,
                                       java.lang.String glossaryTermExternalIdentifier,
                                       java.util.Date effectiveTime,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Classify the glossary term to indicate that it describes a data value.
        Specified by:
        setTermAsDataValue in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsDataValue

        public void clearTermAsDataValue​(java.lang.String userId,
                                         java.lang.String assetManagerGUID,
                                         java.lang.String assetManagerName,
                                         java.lang.String glossaryTermGUID,
                                         java.lang.String glossaryTermExternalIdentifier,
                                         java.util.Date effectiveTime,
                                         boolean forLineage,
                                         boolean forDuplicateProcessing)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Remove the data value designation from the glossary term.
        Specified by:
        clearTermAsDataValue in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsActivity

        public void setTermAsActivity​(java.lang.String userId,
                                      java.lang.String assetManagerGUID,
                                      java.lang.String assetManagerName,
                                      java.lang.String glossaryTermGUID,
                                      java.lang.String glossaryTermExternalIdentifier,
                                      GlossaryTermActivityType activityType,
                                      java.util.Date effectiveTime,
                                      boolean forLineage,
                                      boolean forDuplicateProcessing)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Classify the glossary term to indicate that it describes a data value.
        Specified by:
        setTermAsActivity in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        activityType - type of activity
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsActivity

        public void clearTermAsActivity​(java.lang.String userId,
                                        java.lang.String assetManagerGUID,
                                        java.lang.String assetManagerName,
                                        java.lang.String glossaryTermGUID,
                                        java.lang.String glossaryTermExternalIdentifier,
                                        java.util.Date effectiveTime,
                                        boolean forLineage,
                                        boolean forDuplicateProcessing)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Remove the activity designation from the glossary term.
        Specified by:
        clearTermAsActivity in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsContext

        public void setTermAsContext​(java.lang.String userId,
                                     java.lang.String assetManagerGUID,
                                     java.lang.String assetManagerName,
                                     java.lang.String glossaryTermGUID,
                                     java.lang.String glossaryTermExternalIdentifier,
                                     GlossaryTermContextDefinition contextDefinition,
                                     java.util.Date effectiveTime,
                                     boolean forLineage,
                                     boolean forDuplicateProcessing)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Classify the glossary term to indicate that it describes a context.
        Specified by:
        setTermAsContext in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        contextDefinition - more details of the context
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsContext

        public void clearTermAsContext​(java.lang.String userId,
                                       java.lang.String assetManagerGUID,
                                       java.lang.String assetManagerName,
                                       java.lang.String glossaryTermGUID,
                                       java.lang.String glossaryTermExternalIdentifier,
                                       java.util.Date effectiveTime,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Remove the context definition designation from the glossary term.
        Specified by:
        clearTermAsContext in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsSpineObject

        public void setTermAsSpineObject​(java.lang.String userId,
                                         java.lang.String assetManagerGUID,
                                         java.lang.String assetManagerName,
                                         java.lang.String glossaryTermGUID,
                                         java.lang.String glossaryTermExternalIdentifier,
                                         java.util.Date effectiveTime,
                                         boolean forLineage,
                                         boolean forDuplicateProcessing)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Classify the glossary term to indicate that it describes a spine object.
        Specified by:
        setTermAsSpineObject in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsSpineObject

        public void clearTermAsSpineObject​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String glossaryTermGUID,
                                           java.lang.String glossaryTermExternalIdentifier,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the spine object designation from the glossary term.
        Specified by:
        clearTermAsSpineObject in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsSpineAttribute

        public void setTermAsSpineAttribute​(java.lang.String userId,
                                            java.lang.String assetManagerGUID,
                                            java.lang.String assetManagerName,
                                            java.lang.String glossaryTermGUID,
                                            java.lang.String glossaryTermExternalIdentifier,
                                            java.util.Date effectiveTime,
                                            boolean forLineage,
                                            boolean forDuplicateProcessing)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException
        Classify the glossary term to indicate that it describes a spine attribute.
        Specified by:
        setTermAsSpineAttribute in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsSpineAttribute

        public void clearTermAsSpineAttribute​(java.lang.String userId,
                                              java.lang.String assetManagerGUID,
                                              java.lang.String assetManagerName,
                                              java.lang.String glossaryTermGUID,
                                              java.lang.String glossaryTermExternalIdentifier,
                                              java.util.Date effectiveTime,
                                              boolean forLineage,
                                              boolean forDuplicateProcessing)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Remove the spine attribute designation from the glossary term.
        Specified by:
        clearTermAsSpineAttribute in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setTermAsObjectIdentifier

        public void setTermAsObjectIdentifier​(java.lang.String userId,
                                              java.lang.String assetManagerGUID,
                                              java.lang.String assetManagerName,
                                              java.lang.String glossaryTermGUID,
                                              java.lang.String glossaryTermExternalIdentifier,
                                              java.util.Date effectiveTime,
                                              boolean forLineage,
                                              boolean forDuplicateProcessing)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Classify the glossary term to indicate that it describes an object identifier.
        Specified by:
        setTermAsObjectIdentifier in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearTermAsObjectIdentifier

        public void clearTermAsObjectIdentifier​(java.lang.String userId,
                                                java.lang.String assetManagerGUID,
                                                java.lang.String assetManagerName,
                                                java.lang.String glossaryTermGUID,
                                                java.lang.String glossaryTermExternalIdentifier,
                                                java.util.Date effectiveTime,
                                                boolean forLineage,
                                                boolean forDuplicateProcessing)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Remove the object identifier designation from the glossary term.
        Specified by:
        clearTermAsObjectIdentifier in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to update
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeGlossaryTerm

        public void removeGlossaryTerm​(java.lang.String userId,
                                       java.lang.String assetManagerGUID,
                                       java.lang.String assetManagerName,
                                       java.lang.String glossaryTermGUID,
                                       java.lang.String glossaryTermExternalIdentifier,
                                       java.util.Date effectiveTime,
                                       boolean forLineage,
                                       boolean forDuplicateProcessing)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Remove the metadata element representing a glossary term.
        Specified by:
        removeGlossaryTerm in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the metadata element to remove
        glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • findGlossaryTerms

        public java.util.List<GlossaryTermElement> findGlossaryTerms​(java.lang.String userId,
                                                                     java.lang.String assetManagerGUID,
                                                                     java.lang.String assetManagerName,
                                                                     java.lang.String searchString,
                                                                     int startFrom,
                                                                     int pageSize,
                                                                     java.util.Date effectiveTime,
                                                                     boolean forLineage,
                                                                     boolean forDuplicateProcessing)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException
        Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.
        Specified by:
        findGlossaryTerms in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        searchString - string to find in the properties
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getTermsForGlossary

        public java.util.List<GlossaryTermElement> getTermsForGlossary​(java.lang.String userId,
                                                                       java.lang.String assetManagerGUID,
                                                                       java.lang.String assetManagerName,
                                                                       java.lang.String glossaryGUID,
                                                                       int startFrom,
                                                                       int pageSize,
                                                                       java.util.Date effectiveTime,
                                                                       boolean forLineage,
                                                                       boolean forDuplicateProcessing)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException
        Retrieve the list of glossary terms associated with a glossary.
        Specified by:
        getTermsForGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryGUID - unique identifier of the glossary of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of associated metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getTermsForGlossaryCategory

        public java.util.List<GlossaryTermElement> getTermsForGlossaryCategory​(java.lang.String userId,
                                                                               java.lang.String assetManagerGUID,
                                                                               java.lang.String assetManagerName,
                                                                               java.lang.String glossaryCategoryGUID,
                                                                               int startFrom,
                                                                               int pageSize,
                                                                               java.util.Date effectiveTime,
                                                                               boolean forLineage,
                                                                               boolean forDuplicateProcessing)
                                                                        throws InvalidParameterException,
                                                                               UserNotAuthorizedException,
                                                                               PropertyServerException
        Retrieve the list of glossary terms associated with a glossary category.
        Specified by:
        getTermsForGlossaryCategory in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryCategoryGUID - unique identifier of the glossary category of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of associated metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossaryTermsByName

        public java.util.List<GlossaryTermElement> getGlossaryTermsByName​(java.lang.String userId,
                                                                          java.lang.String assetManagerGUID,
                                                                          java.lang.String assetManagerName,
                                                                          java.lang.String name,
                                                                          int startFrom,
                                                                          int pageSize,
                                                                          java.util.Date effectiveTime,
                                                                          boolean forLineage,
                                                                          boolean forDuplicateProcessing)
                                                                   throws InvalidParameterException,
                                                                          UserNotAuthorizedException,
                                                                          PropertyServerException
        Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
        Specified by:
        getGlossaryTermsByName in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossaryTermByGUID

        public GlossaryTermElement getGlossaryTermByGUID​(java.lang.String userId,
                                                         java.lang.String assetManagerGUID,
                                                         java.lang.String assetManagerName,
                                                         java.lang.String glossaryTermGUID,
                                                         java.util.Date effectiveTime,
                                                         boolean forLineage,
                                                         boolean forDuplicateProcessing)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException
        Retrieve the glossary term metadata element with the supplied unique identifier.
        Specified by:
        getGlossaryTermByGUID in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        glossaryTermGUID - unique identifier of the requested metadata element
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        matching metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createExternalGlossaryLink

        public java.lang.String createExternalGlossaryLink​(java.lang.String userId,
                                                           java.lang.String assetManagerGUID,
                                                           java.lang.String assetManagerName,
                                                           ExternalGlossaryLinkProperties linkProperties)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
        Specified by:
        createExternalGlossaryLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        linkProperties - properties of the link
        Returns:
        unique identifier of the external reference
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateExternalGlossaryLink

        public void updateExternalGlossaryLink​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               java.lang.String externalLinkGUID,
                                               boolean isMergeUpdate,
                                               ExternalGlossaryLinkProperties linkProperties,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Update the properties of a reference to an external glossary resource.
        Specified by:
        updateExternalGlossaryLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        linkProperties - properties of the link
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeExternalGlossaryLink

        public void removeExternalGlossaryLink​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               java.lang.String externalLinkGUID,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
        Specified by:
        removeExternalGlossaryLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • attachExternalLinkToGlossary

        public void attachExternalLinkToGlossary​(java.lang.String userId,
                                                 java.lang.String assetManagerGUID,
                                                 java.lang.String assetManagerName,
                                                 java.lang.String externalLinkGUID,
                                                 java.lang.String glossaryGUID,
                                                 java.util.Date effectiveTime,
                                                 boolean forLineage,
                                                 boolean forDuplicateProcessing)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Connect a glossary to a reference to an external glossary resource.
        Specified by:
        attachExternalLinkToGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryGUID - unique identifier of the metadata element to attach
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • detachExternalLinkFromGlossary

        public void detachExternalLinkFromGlossary​(java.lang.String userId,
                                                   java.lang.String assetManagerGUID,
                                                   java.lang.String assetManagerName,
                                                   java.lang.String externalLinkGUID,
                                                   java.lang.String glossaryGUID,
                                                   java.util.Date effectiveTime,
                                                   boolean forLineage,
                                                   boolean forDuplicateProcessing)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Disconnect a glossary from a reference to an external glossary resource.
        Specified by:
        detachExternalLinkFromGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryGUID - unique identifier of the metadata element to remove
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getExternalLinksForGlossary

        public java.util.List<ExternalGlossaryLinkElement> getExternalLinksForGlossary​(java.lang.String userId,
                                                                                       java.lang.String assetManagerGUID,
                                                                                       java.lang.String assetManagerName,
                                                                                       java.lang.String glossaryGUID,
                                                                                       int startFrom,
                                                                                       int pageSize,
                                                                                       java.util.Date effectiveTime,
                                                                                       boolean forLineage,
                                                                                       boolean forDuplicateProcessing)
                                                                                throws InvalidParameterException,
                                                                                       UserNotAuthorizedException,
                                                                                       PropertyServerException
        Retrieve the list of links to external glossary resources attached to a glossary.
        Specified by:
        getExternalLinksForGlossary in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        glossaryGUID - unique identifier of the metadata element for the glossary of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        Returns:
        list of attached links to external glossary resources
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getGlossariesForExternalLink

        public java.util.List<GlossaryElement> getGlossariesForExternalLink​(java.lang.String userId,
                                                                            java.lang.String assetManagerGUID,
                                                                            java.lang.String assetManagerName,
                                                                            java.lang.String externalLinkGUID,
                                                                            int startFrom,
                                                                            int pageSize,
                                                                            java.util.Date effectiveTime,
                                                                            boolean forLineage,
                                                                            boolean forDuplicateProcessing)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            PropertyServerException
        Return the glossaries connected to an external glossary source.
        Specified by:
        getGlossariesForExternalLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the metadata element for the external glossary link of interest
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Returns:
        list of glossaries
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • attachExternalCategoryLink

        public void attachExternalCategoryLink​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               java.lang.String externalLinkGUID,
                                               java.lang.String glossaryCategoryGUID,
                                               ExternalGlossaryElementLinkProperties linkProperties,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Create a link to an external glossary category resource. This is associated with a category to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
        Specified by:
        attachExternalCategoryLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryCategoryGUID - unique identifier for the glossary category
        linkProperties - properties of the link
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • detachExternalCategoryLink

        public void detachExternalCategoryLink​(java.lang.String userId,
                                               java.lang.String assetManagerGUID,
                                               java.lang.String assetManagerName,
                                               java.lang.String externalLinkGUID,
                                               java.lang.String glossaryCategoryGUID,
                                               java.util.Date effectiveTime,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Remove the link to an external glossary category resource.
        Specified by:
        detachExternalCategoryLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryCategoryGUID - unique identifier for the glossary category
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • attachExternalTermLink

        public void attachExternalTermLink​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String externalLinkGUID,
                                           java.lang.String glossaryTermGUID,
                                           ExternalGlossaryElementLinkProperties linkProperties,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a link to an external glossary term resource. This is associated with a term to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
        Specified by:
        attachExternalTermLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryTermGUID - unique identifier for the glossary category
        linkProperties - properties of the link
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • detachExternalTermLink

        public void detachExternalTermLink​(java.lang.String userId,
                                           java.lang.String assetManagerGUID,
                                           java.lang.String assetManagerName,
                                           java.lang.String externalLinkGUID,
                                           java.lang.String glossaryTermGUID,
                                           java.util.Date effectiveTime,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Remove the link to an external glossary term resource.
        Specified by:
        detachExternalTermLink in interface GlossaryExchangeInterface
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software server capability representing the caller
        assetManagerName - unique name of software server capability representing the caller
        externalLinkGUID - unique identifier of the external reference
        glossaryTermGUID - unique identifier for the glossary category
        effectiveTime - the time that the retrieved elements must be effective for
        forLineage - return elements marked with the Memento classification?
        forDuplicateProcessing - do not merge elements marked as duplicates?
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)