Interface GlossaryExchangeInterface

  • All Known Implementing Classes:
    GlossaryExchangeClient

    public interface GlossaryExchangeInterface
    GlossaryExchangeInterface defines the client side interface for the Asset Manager OMAS that is relevant for managing glossaries. It provides the ability to define and maintain the content of glossary as well as govern it. Glossaries have a top-level root object that describe the purpose, language and intended usage of its content. Linked to the glossary's root object are the terms, categories and relationships it contains. In addition to the content, the glossary can be augmented with classifications and linked to external glossary definitions.
    • Method Summary

      All Methods Instance Methods Abstract 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 openMetadataGUID)
      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 properties of 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.
    • Method Detail

      • createGlossary

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        externalIdentifierProperties - optional properties used to define an external identifier
        templateGUID - unique identifier of the metadata element to copy
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        glossaryGUID - unique identifier of the metadata element to classify
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        glossaryGUID - unique identifier of the metadata element to unclassify
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        glossaryGUID - unique identifier of the metadata element to classify
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        glossaryGUID - unique identifier of the metadata element to unclassify
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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)
      • getGlossariesForAssetManager

        java.util.List<GlossaryElement> getGlossariesForAssetManager​(java.lang.String userId,
                                                                     java.lang.String assetManagerGUID,
                                                                     java.lang.String assetManagerName,
                                                                     int startFrom,
                                                                     int pageSize)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException
        Retrieve the list of glossaries created on behalf of the named asset manager.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        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)
      • getGlossaryByGUID

        GlossaryElement getGlossaryByGUID​(java.lang.String userId,
                                          java.lang.String assetManagerGUID,
                                          java.lang.String assetManagerName,
                                          java.lang.String openMetadataGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Retrieve the glossary metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        openMetadataGUID - unique identifier of the requested metadata element
        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)
      • createGlossaryCategory

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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 properties of the metadata element representing a glossary term.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        glossaryTermGUID - unique identifier of the glossary term to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        glossaryTermProperties - new properties for the glossary term
        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)
      • updateGlossaryTermStatus

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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 related to the new 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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).
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software capability representing the caller
        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?
        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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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

        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.
        Parameters:
        userId - calling user
        assetManagerGUID - unique identifier of software capability representing the caller
        assetManagerName - unique name of software 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)