Package org.odpi.openmetadata.accessservices.assetmanager.client.management

Class GlossaryManagementClient

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.client.management.GlossaryManagementClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
public class GlossaryManagementClient extends Object implements org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
GlossaryManagementClient is the client for managing resources from a glossary.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GlossaryManagementClient(String serverName, String serverPlatformURLRoot)
    Create a new client with no authentication embedded in the HTTP request.
    GlossaryManagementClient(String serverName, String serverPlatformURLRoot, String userId, String password)
    Create a new client that passes userId and password in each HTTP request.
    GlossaryManagementClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that passes userId and password in each HTTP request.
    GlossaryManagementClient(String serverName, String serverPlatformURLRoot, AssetManagerRESTClient restClient, int maxPageSize, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client that is going to be used in an OMAG Server.
    GlossaryManagementClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog)
    Create a new client with no authentication embedded in the HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    archiveGlossaryTerm(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ArchiveProperties archiveProperties, Date effectiveTime, boolean forDuplicateProcessing)
    Archive the metadata element representing a glossary term.
    void
    attachExternalCategoryLink(String userId, String externalLinkGUID, String glossaryCategoryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a link to an external glossary category resource.
    void
    attachExternalLinkToGlossary(String userId, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Connect a glossary to a reference to an external glossary resource.
    void
    attachExternalTermLink(String userId, String externalLinkGUID, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a link to an external glossary term resource.
    void
    clearCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove a parent-child relationship between two categories.
    void
    clearGlossaryAsCanonical(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the canonical designation from the glossary.
    void
    clearGlossaryAsEditingGlossary(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the editing glossary classification from the glossary.
    void
    clearGlossaryAsStagingGlossary(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the staging glossary classification from the glossary.
    void
    clearGlossaryAsTaxonomy(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the taxonomy designation from the glossary.
    void
    clearTermAsAbstractConcept(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the abstract concept designation from the glossary term.
    void
    clearTermAsActivity(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the activity designation from the glossary term.
    void
    clearTermAsContext(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the context definition designation from the glossary term.
    void
    clearTermAsDataField(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the data field designation from the glossary term.
    void
    clearTermAsDataValue(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the data value designation from the glossary term.
    void
    clearTermAsObjectIdentifier(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the object identifier designation from the glossary term.
    void
    clearTermAsSpineAttribute(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the spine attribute designation from the glossary term.
    void
    clearTermAsSpineObject(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the spine object designation from the glossary term.
    void
    clearTermCategory(String userId, String glossaryCategoryGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Unlink a term from a category.
    void
    clearTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the relationship between two terms.
    String
    createControlledGlossaryTerm(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus initialStatus, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
    String
    createExternalGlossaryLink(String userId, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryLinkProperties linkProperties)
    Create a link to an external glossary resource.
    String
    createGlossary(String userId, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryProperties glossaryProperties)
    Create a new metadata element to represent the root of a glossary.
    String
    createGlossaryCategory(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryCategoryProperties glossaryCategoryProperties, boolean isRootCategory, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a new metadata element to represent a glossary category.
    String
    createGlossaryCategoryFromTemplate(String userId, String glossaryGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy)
    Create a new metadata element to represent a glossary category using an existing metadata element as a template.
    String
    createGlossaryFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy)
    Create a new metadata element to represent a glossary using an existing metadata element as a template.
    String
    createGlossaryTerm(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a new metadata element to represent a glossary term.
    String
    createGlossaryTermFromTemplate(String userId, String glossaryGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy, boolean templateSubstitute, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus initialStatus)
    Create a new metadata element to represent a glossary term using an existing metadata element as a template.
    void
    detachExternalCategoryLink(String userId, String externalLinkGUID, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the link to an external glossary category resource.
    void
    detachExternalLinkFromGlossary(String userId, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Disconnect a glossary from a reference to an external glossary resource.
    void
    detachExternalTermLink(String userId, String externalLinkGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the link to an external glossary term resource.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement>
    findGlossaries(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement>
    findGlossaryCategories(String userId, String glossaryGUID, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary category metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    findGlossaryTerms(String userId, String glossaryGUID, String searchString, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary term metadata elements that contain the search string.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement>
    getCategoriesForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Return the list of categories associated with a glossary.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement>
    getCategoriesForTerm(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Return the list of categories associated with a glossary term.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ExternalGlossaryLinkElement>
    getExternalLinksForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of links to external glossary resources attached to a glossary.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement>
    getGlossariesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement>
    getGlossariesForExternalLink(String userId, String externalLinkGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Return the glossaries connected to an external glossary source.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement
    getGlossaryByGUID(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement>
    getGlossaryCategoriesByName(String userId, String glossaryGUID, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary category metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement
    getGlossaryCategoryByGUID(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement
    getGlossaryCategoryParent(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement
    getGlossaryForCategory(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary metadata element for the requested category.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement
    getGlossaryForTerm(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary metadata element for the requested term.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement>
    getGlossarySubCategories(String userId, String glossaryCategoryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary category metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement
    getGlossaryTermByGUID(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the glossary term metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    getGlossaryTermHistory(String userId, String glossaryTermGUID, Date fromTime, Date toTime, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
    Retrieve all the versions of a glossary term.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    getGlossaryTermsByName(String userId, String glossaryGUID, String name, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary term metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    getRelatedTerms(String userId, String glossaryTermGUID, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationshipStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary terms associated with the requested glossary term.
    List<String>
    getTermRelationshipTypeNames(String userId)
    Return the list of term-to-term relationship names.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    getTermsForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary terms associated with a glossary.
    List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement>
    getTermsForGlossaryCategory(String userId, String glossaryCategoryGUID, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationshipStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Retrieve the list of glossary terms associated with a glossary category.
    void
    moveGlossaryTerm(String userId, String glossaryTermGUID, String newGlossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Move a glossary term from one glossary to another.
    void
    removeExternalGlossaryLink(String userId, String externalLinkGUID, 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(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the metadata element representing a glossary.
    void
    removeGlossaryCategory(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the metadata element representing a glossary category.
    void
    removeGlossaryTerm(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Remove the metadata element representing a glossary term.
    void
    setGlossaryAsCanonical(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.CanonicalVocabularyProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.
    void
    setGlossaryAsEditingGlossary(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.EditingGlossaryProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.
    void
    setGlossaryAsStagingGlossary(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.StagingGlossaryProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into another glossary.
    void
    setGlossaryAsTaxonomy(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TaxonomyProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary to indicate that it can be used as a taxonomy.
    void
    setTermAsAbstractConcept(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes an abstract concept.
    void
    setTermAsActivity(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ActivityDescriptionProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a data value.
    void
    setTermAsContext(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermContextDefinition contextDefinition, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a context.
    void
    setTermAsDataField(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFieldValuesProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
    void
    setTermAsDataValue(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a data value.
    void
    setTermAsObjectIdentifier(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes an object identifier.
    void
    setTermAsSpineAttribute(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a spine attribute.
    void
    setTermAsSpineObject(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Classify the glossary term to indicate that it describes a spine object.
    void
    setupCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Create a parent-child relationship between two categories.
    void
    setupTermCategory(String userId, String glossaryCategoryGUID, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermCategorization categorizationProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Link a term to a category.
    void
    setupTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Link two terms together using a specialist relationship.
    org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement
    undoGlossaryTermUpdate(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Undo the last update to the glossary term.
    void
    updateExternalGlossaryLink(String userId, String externalLinkGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the properties of a reference to an external glossary resource.
    void
    updateGlossary(String userId, String glossaryGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryProperties glossaryProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the metadata element representing a glossary.
    void
    updateGlossaryCategory(String userId, String glossaryCategoryGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryCategoryProperties glossaryCategoryProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the metadata element representing a glossary category.
    void
    updateGlossaryTerm(String userId, String glossaryTermGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the metadata element representing a glossary term.
    void
    updateGlossaryTermFromTemplate(String userId, String glossaryTermGUID, String templateGUID, boolean isMergeClassifications, boolean isMergeProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the glossary term using the properties and classifications from the parentGUID stored in the request body.
    void
    updateGlossaryTermStatus(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus glossaryTermStatus, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the status of the metadata element representing a glossary term.
    void
    updateTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)
    Update the relationship properties for the two terms.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GlossaryManagementClient

      public GlossaryManagementClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      auditLog - logging destination
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • GlossaryManagementClient

      public GlossaryManagementClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • GlossaryManagementClient

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

    • GlossaryManagementClient

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

    • GlossaryManagementClient

      public GlossaryManagementClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • createGlossary

      public String createGlossary(String userId, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryProperties glossaryProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent the root of a glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
      Specified by:
      createGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryProperties - properties to store
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGlossaryFromTemplate

      public String createGlossaryFromTemplate(String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
      Specified by:
      createGlossaryFromTemplate in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      deepCopy - should the template creation extend to the anchored elements or just the direct entity?
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGlossary

      public void updateGlossary(String userId, String glossaryGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryProperties glossaryProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a glossary.
      Specified by:
      updateGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      glossaryProperties - new properties for this 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setGlossaryAsEditingGlossary

      public void setGlossaryAsEditingGlossary(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.EditingGlossaryProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.
      Specified by:
      setGlossaryAsEditingGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element to remove
      properties - description of the purpose of the editing glossary
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearGlossaryAsEditingGlossary

      public void clearGlossaryAsEditingGlossary(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the editing glossary classification from the glossary.
      Specified by:
      clearGlossaryAsEditingGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setGlossaryAsStagingGlossary

      public void setGlossaryAsStagingGlossary(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.StagingGlossaryProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into another glossary.
      Specified by:
      setGlossaryAsStagingGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element to remove
      properties - description of the purpose of the editing glossary
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearGlossaryAsStagingGlossary

      public void clearGlossaryAsStagingGlossary(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the staging glossary classification from the glossary.
      Specified by:
      clearGlossaryAsStagingGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setGlossaryAsTaxonomy

      public void setGlossaryAsTaxonomy(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TaxonomyProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary to indicate that it can be used as a taxonomy. This means each term is attached to one, and only one category and the categories are organized as a hierarchy with a single root category.

      Taxonomies are used as a way of organizing assets and other related metadata. The terms in the taxonomy are linked to the assets etc. and as such they are logically categorized by the linked category.
      Specified by:
      setGlossaryAsTaxonomy in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element to remove
      properties - description of how the glossary is organized
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearGlossaryAsTaxonomy

      public void clearGlossaryAsTaxonomy(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the taxonomy designation from the glossary.
      Specified by:
      clearGlossaryAsTaxonomy in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setGlossaryAsCanonical

      public void setGlossaryAsCanonical(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.CanonicalVocabularyProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name. This means there is only one definition for each term. Typically, the terms are also of a similar level of granularity and are limited to a specific scope of use.

      Canonical vocabularies are used to semantically classify assets in an unambiguous way.
      Specified by:
      setGlossaryAsCanonical in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element to remove
      properties - description of the situations where this glossary is relevant.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearGlossaryAsCanonical

      public void clearGlossaryAsCanonical(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the canonical designation from the glossary.
      Specified by:
      clearGlossaryAsCanonical in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGlossary

      public void removeGlossary(String userId, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.
      Specified by:
      removeGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findGlossaries

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement> findGlossaries(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGlossaries in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossariesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement> getGlossariesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGlossariesByName in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement getGlossaryByGUID(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary metadata element with the supplied unique identifier.
      Specified by:
      getGlossaryByGUID in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryForCategory

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement getGlossaryForCategory(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary metadata element for the requested category.
      Specified by:
      getGlossaryForCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryForTerm

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement getGlossaryForTerm(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary metadata element for the requested term.
      Specified by:
      getGlossaryForTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGlossaryCategory

      public String createGlossaryCategory(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryCategoryProperties glossaryCategoryProperties, boolean isRootCategory, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary category.
      Specified by:
      createGlossaryCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary where the category is located
      glossaryCategoryProperties - properties about the glossary category to store
      isRootCategory - is this category a root 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?
      Returns:
      unique identifier of the new glossary category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGlossaryCategoryFromTemplate

      public String createGlossaryCategoryFromTemplate(String userId, String glossaryGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary category using an existing metadata element as a template.
      Specified by:
      createGlossaryCategoryFromTemplate in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary where the category is located
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      deepCopy - should the template creation extend to the anchored elements or just the direct entity?
      Returns:
      unique identifier of the new glossary category
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGlossaryCategory

      public void updateGlossaryCategory(String userId, String glossaryCategoryGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryCategoryProperties glossaryCategoryProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a glossary category.
      Specified by:
      updateGlossaryCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryCategoryGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupCategoryParent

      public void setupCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a parent-child relationship between two categories.
      Specified by:
      setupCategoryParent in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearCategoryParent

      public void clearCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a parent-child relationship between two categories.
      Specified by:
      clearCategoryParent in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGlossaryCategory

      public void removeGlossaryCategory(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a glossary category.
      Specified by:
      removeGlossaryCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryCategoryGUID - 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findGlossaryCategories

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement> findGlossaryCategories(String userId, String glossaryGUID, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGlossaryCategories in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - optional glossary unique identifier to scope the search to a glossary.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getCategoriesForGlossary

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement> getCategoriesForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of categories associated with a glossary.
      Specified by:
      getCategoriesForGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getCategoriesForTerm

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement> getCategoriesForTerm(String userId, String glossaryTermGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of categories associated with a glossary term.
      Specified by:
      getCategoriesForTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term 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 term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryCategoriesByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement> getGlossaryCategoriesByName(String userId, String glossaryGUID, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGlossaryCategoriesByName in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - optional glossary unique identifier to scope the search to a glossary.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryCategoryByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement getGlossaryCategoryByGUID(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Specified by:
      getGlossaryCategoryByGUID in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryCategoryParent

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement getGlossaryCategoryParent(String userId, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Specified by:
      getGlossaryCategoryParent in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossarySubCategories

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryCategoryElement> getGlossarySubCategories(String userId, String glossaryCategoryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary category metadata element with the supplied unique identifier.
      Specified by:
      getGlossarySubCategories in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGlossaryTerm

      public String createGlossaryTerm(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary term.
      Specified by:
      createGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary where the term is located
      glossaryTermProperties - 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?
      Returns:
      unique identifier of the new metadata element for the glossary term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createControlledGlossaryTerm

      public String createControlledGlossaryTerm(String userId, String glossaryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus initialStatus, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
      Specified by:
      createControlledGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary where the term is located
      glossaryTermProperties - properties for the glossary term
      initialStatus - glossary term status to use when the object is created
      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:
      unique identifier of the new metadata element for the glossary term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createGlossaryTermFromTemplate

      public String createGlossaryTermFromTemplate(String userId, String glossaryGUID, String templateGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.TemplateProperties templateProperties, boolean deepCopy, boolean templateSubstitute, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus initialStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new metadata element to represent a glossary term using an existing metadata element as a template.
      Specified by:
      createGlossaryTermFromTemplate in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary where the term is located
      templateGUID - unique identifier of the metadata element to copy
      templateProperties - properties that override the template
      deepCopy - should the template creation extend to the anchored elements or just the direct entity?
      templateSubstitute - is this element a template substitute (used as the "other end" of a new/updated relationship)
      initialStatus - what status should the copy be set to
      Returns:
      unique identifier of the new metadata element for the glossary term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGlossaryTerm

      public void updateGlossaryTerm(String userId, String glossaryTermGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermProperties glossaryTermProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a glossary term.
      Specified by:
      updateGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGlossaryTermStatus

      public void updateGlossaryTermStatus(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus glossaryTermStatus, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.
      Specified by:
      updateGlossaryTermStatus in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateGlossaryTermFromTemplate

      public void updateGlossaryTermFromTemplate(String userId, String glossaryTermGUID, String templateGUID, boolean isMergeClassifications, boolean isMergeProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the glossary term using the properties and classifications from the parentGUID stored in the request body.
      Specified by:
      updateGlossaryTermFromTemplate in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term to update
      templateGUID - identifier for the template glossary term
      isMergeClassifications - should the classification be merged or replace the target entity?
      isMergeProperties - should the properties be merged with the existing ones or replace them
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • moveGlossaryTerm

      public void moveGlossaryTerm(String userId, String glossaryTermGUID, String newGlossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Move a glossary term from one glossary to another.
      Specified by:
      moveGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term to update
      newGlossaryGUID - identifier for the new glossary
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupTermCategory

      public void setupTermCategory(String userId, String glossaryCategoryGUID, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermCategorization categorizationProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link a term to a category.
      Specified by:
      setupTermCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermCategory

      public void clearTermCategory(String userId, String glossaryCategoryGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Unlink a term from a category.
      Specified by:
      clearTermCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getTermRelationshipTypeNames

      public List<String> getTermRelationshipTypeNames(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the list of term-to-term relationship names.
      Specified by:
      getTermRelationshipTypeNames in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      Returns:
      list of type names that are subtypes of asset
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setupTermRelationship

      public void setupTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link two terms together using a specialist relationship.
      Specified by:
      setupTermRelationship in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateTermRelationship

      public void updateTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the relationship properties for the two terms.
      Specified by:
      updateTermRelationship in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermRelationship

      public void clearTermRelationship(String userId, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the relationship between two terms.
      Specified by:
      clearTermRelationship in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsAbstractConcept

      public void setTermAsAbstractConcept(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes an abstract concept.
      Specified by:
      setTermAsAbstractConcept in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsAbstractConcept

      public void clearTermAsAbstractConcept(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the abstract concept designation from the glossary term.
      Specified by:
      clearTermAsAbstractConcept in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsDataField

      public void setTermAsDataField(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.DataFieldValuesProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
      Specified by:
      setTermAsDataField in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      properties - characterizations of the data values stored in the data field
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsDataField

      public void clearTermAsDataField(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the data field designation from the glossary term.
      Specified by:
      clearTermAsDataField in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsDataValue

      public void setTermAsDataValue(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a data value.
      Specified by:
      setTermAsDataValue in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsDataValue

      public void clearTermAsDataValue(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the data value designation from the glossary term.
      Specified by:
      clearTermAsDataValue in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsActivity

      public void setTermAsActivity(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ActivityDescriptionProperties properties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a data value.
      Specified by:
      setTermAsActivity in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      properties - 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsActivity

      public void clearTermAsActivity(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the activity designation from the glossary term.
      Specified by:
      clearTermAsActivity in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsContext

      public void setTermAsContext(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermContextDefinition contextDefinition, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a context.
      Specified by:
      setTermAsContext in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsContext

      public void clearTermAsContext(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the context definition designation from the glossary term.
      Specified by:
      clearTermAsContext in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsSpineObject

      public void setTermAsSpineObject(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a spine object.
      Specified by:
      setTermAsSpineObject in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsSpineObject

      public void clearTermAsSpineObject(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the spine object designation from the glossary term.
      Specified by:
      clearTermAsSpineObject in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsSpineAttribute

      public void setTermAsSpineAttribute(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes a spine attribute.
      Specified by:
      setTermAsSpineAttribute in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsSpineAttribute

      public void clearTermAsSpineAttribute(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the spine attribute designation from the glossary term.
      Specified by:
      clearTermAsSpineAttribute in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • setTermAsObjectIdentifier

      public void setTermAsObjectIdentifier(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Classify the glossary term to indicate that it describes an object identifier.
      Specified by:
      setTermAsObjectIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • clearTermAsObjectIdentifier

      public void clearTermAsObjectIdentifier(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the object identifier designation from the glossary term.
      Specified by:
      clearTermAsObjectIdentifier in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • undoGlossaryTermUpdate

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement undoGlossaryTermUpdate(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Undo the last update to the glossary term.
      Specified by:
      undoGlossaryTermUpdate in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to update
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • archiveGlossaryTerm

      public void archiveGlossaryTerm(String userId, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ArchiveProperties archiveProperties, Date effectiveTime, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Archive the metadata element representing a glossary term. This removes it from normal access. However, it is still available for lineage requests.
      Specified by:
      archiveGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the metadata element to archive
      archiveProperties - option parameters about the archive process
      effectiveTime - the time that the retrieved elements must be effective for
      forDuplicateProcessing - do not merge elements marked as duplicates?
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeGlossaryTerm

      public void removeGlossaryTerm(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a glossary term.
      Specified by:
      removeGlossaryTerm in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - 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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • findGlossaryTerms

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> findGlossaryTerms(String userId, String glossaryGUID, String searchString, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.
      Specified by:
      findGlossaryTerms in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary to query
      searchString - string to find in the properties
      limitResultsByStatus - By default, terms in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getTermsForGlossary

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> getTermsForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary terms associated with a glossary.
      Specified by:
      getTermsForGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getTermsForGlossaryCategory

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> getTermsForGlossaryCategory(String userId, String glossaryCategoryGUID, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationshipStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary terms associated with a glossary category.
      Specified by:
      getTermsForGlossaryCategory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryCategoryGUID - unique identifier of the glossary category of interest
      limitResultsByStatus - By default, term relationships in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getRelatedTerms

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> getRelatedTerms(String userId, String glossaryTermGUID, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermRelationshipStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary terms associated with the requested glossary term.
      Specified by:
      getRelatedTerms in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of the glossary term of interest
      limitResultsByStatus - By default, term relationships in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryTermsByName

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> getGlossaryTermsByName(String userId, String glossaryGUID, String name, List<org.odpi.openmetadata.accessservices.assetmanager.properties.GlossaryTermStatus> limitResultsByStatus, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Specified by:
      getGlossaryTermsByName in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the glossary to query
      name - name to search for
      limitResultsByStatus - By default, terms in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryTermByGUID

      public org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement getGlossaryTermByGUID(String userId, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the glossary term metadata element with the supplied unique identifier.
      Specified by:
      getGlossaryTermByGUID in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossaryTermHistory

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryTermElement> getGlossaryTermHistory(String userId, String glossaryTermGUID, Date fromTime, Date toTime, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Retrieve all the versions of a glossary term.
      Specified by:
      getGlossaryTermHistory in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryTermGUID - unique identifier of object to retrieve
      fromTime - the earliest point in time from which to retrieve historical versions of the entity (inclusive)
      toTime - the latest point in time from which to retrieve historical versions of the entity (exclusive)
      startFrom - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.
      pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.
      oldestFirst - defining how the results should be ordered.
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      list of beans
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem removing the properties from the repositories.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createExternalGlossaryLink

      public String createExternalGlossaryLink(String userId, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryLinkProperties linkProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
      Specified by:
      createExternalGlossaryLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      linkProperties - properties of the link
      Returns:
      unique identifier of the external reference
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • updateExternalGlossaryLink

      public void updateExternalGlossaryLink(String userId, String externalLinkGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the properties of a reference to an external glossary resource.
      Specified by:
      updateExternalGlossaryLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • removeExternalGlossaryLink

      public void removeExternalGlossaryLink(String userId, String externalLinkGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
      Specified by:
      removeExternalGlossaryLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • attachExternalLinkToGlossary

      public void attachExternalLinkToGlossary(String userId, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Connect a glossary to a reference to an external glossary resource.
      Specified by:
      attachExternalLinkToGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • detachExternalLinkFromGlossary

      public void detachExternalLinkFromGlossary(String userId, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Disconnect a glossary from a reference to an external glossary resource.
      Specified by:
      detachExternalLinkFromGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getExternalLinksForGlossary

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.ExternalGlossaryLinkElement> getExternalLinksForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of links to external glossary resources attached to a glossary.
      Specified by:
      getExternalLinksForGlossary in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      glossaryGUID - unique identifier of the metadata element for the glossary of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      effectiveTime - the time that the retrieved elements must be effective for
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      Returns:
      list of attached links to external glossary resources
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getGlossariesForExternalLink

      public List<org.odpi.openmetadata.accessservices.assetmanager.metadataelements.GlossaryElement> getGlossariesForExternalLink(String userId, String externalLinkGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return the glossaries connected to an external glossary source.
      Specified by:
      getGlossariesForExternalLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • attachExternalCategoryLink

      public void attachExternalCategoryLink(String userId, String externalLinkGUID, String glossaryCategoryGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link to an external glossary category resource. This is associated with a category to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
      Specified by:
      attachExternalCategoryLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • detachExternalCategoryLink

      public void detachExternalCategoryLink(String userId, String externalLinkGUID, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the link to an external glossary category resource.
      Specified by:
      detachExternalCategoryLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • attachExternalTermLink

      public void attachExternalTermLink(String userId, String externalLinkGUID, String glossaryTermGUID, org.odpi.openmetadata.accessservices.assetmanager.properties.ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link to an external glossary term resource. This is associated with a term to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
      Specified by:
      attachExternalTermLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • detachExternalTermLink

      public void detachExternalTermLink(String userId, String externalLinkGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the link to an external glossary term resource.
      Specified by:
      detachExternalTermLink in interface org.odpi.openmetadata.accessservices.assetmanager.api.management.GlossaryManagementInterface
      Parameters:
      userId - calling user
      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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)