Package org.odpi.openmetadata.viewservices.glossaryauthor.handlers

Class RelationshipHandler

java.lang.Object
org.odpi.openmetadata.viewservices.glossaryauthor.handlers.RelationshipHandler
public class RelationshipHandler extends Object
The relationship handler is initialised with a SubjectAreaRelationship, that contains the server the call should be sent to. The handler exposes methods for term functionality for the glossary author view

  • Constructor Summary

    Constructors
    Constructor
    Description
    RelationshipHandler(org.odpi.openmetadata.accessservices.subjectarea.client.relationships.SubjectAreaRelationshipClients subjectAreaRelationship)
    Constructor for the RelationshipHandler

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym
    createAntonymRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym)
    Create a antonym relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink
    createCategoryHierarchyLink(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink)
    Create a CategoryHierarchyLink Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA
    createIsaRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa)
    Create a Isa relationship, which is link between a more general glossary term and a more specific definition.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf
    createIsATypeOf(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf)
    Create a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated
    createIsATypeOfDeprecated(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf)
    Create a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm
    createPreferredTermRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm)
    Create a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope
    createProjectScopeRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScope)
    Create a ProjectScope relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    createRelatedTerm(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationship)
    Create a RelatedTerm.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm
    createReplacementTermRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm)
    Create a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym
    createSynonymRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym)
    Create a synonym relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization
    createTermCategorizationRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship)
    Create a Term Categorization Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA
    createTermHasARelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship)
    Create a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy
    createTermTYPEDBYRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship)
    Create a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation
    createTranslationRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation)
    Create a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext
    createUsedInContextRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext)
    Create a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue
    createValidValueRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue)
    Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    void
    deleteAntonymRelationship(String userId, String guid)
    Delete a antonym relationship.
    void
    deleteCategoryHierarchyLink(String userId, String guid)
    Delete a CategoryHierarchyLink Relationship.
    void
    deleteIsaRelationship(String userId, String guid)
    Delete a isa relationship, which is link between a more general glossary term and a more specific definition.
    void
    deleteIsATypeOf(String userId, String guid)
    Delete a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    void
    deleteIsATypeOfDeprecated(String userId, String guid)
    Delete a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    void
    deletePreferredTermRelationship(String userId, String guid)
    Delete a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    void
    deleteProjectScopeRelationship(String userId, String guid)
    Delete a ProjectScope relationship.
    void
    deleteRelatedTerm(String userId, String guid)
    Delete a RelatedTerm.
    void
    deleteReplacementTermRelationship(String userId, String guid)
    Delete a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    void
    deleteSynonymRelationship(String userId, String guid)
    Delete a synonym relationship.
    void
    deleteTermCategorizationRelationship(String userId, String guid)
    Delete a Term Categorization Relationship.
    void
    deleteTermHasARelationship(String userId, String guid)
    Delete a Term HasA Relationship.
    void
    deleteTermTYPEDBYRelationship(String userId, String guid)
    Delete a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    void
    deleteTranslationRelationship(String userId, String guid)
    Delete a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    void
    deleteUsedInContextRelationship(String userId, String guid)
    Delete a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    void
    deleteValidValueRelationship(String userId, String guid)
    Delete a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym
    getAntonymRelationship(String userId, String guid)
    Get a antonym relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryAnchor
    getCategoryAnchorRelationship(String userId, String guid)
    Get a Category Anchor Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink
    getCategoryHierarchyLink(String userId, String guid)
    Get a CategoryHierarchyLink Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA
    getIsaRelationship(String userId, String guid)
    Get a isa relationship, which is link between a more general glossary term and a more specific definition.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf
    getIsATypeOf(String userId, String guid)
    Get a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated
    getIsATypeOfDeprecated(String userId, String guid)
    Get a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm
    getPreferredTermRelationship(String userId, String guid)
    Get a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope
    getProjectScopeRelationship(String userId, String guid)
    Get a ProjectScope relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    getRelatedTerm(String userId, String guid)
    Get a RelatedTerm.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm
    getReplacementTermRelationship(String userId, String guid)
    Get a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.SemanticAssignment
    getSemanticAssignmentRelationship(String userId, String guid)
    Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym
    getSynonymRelationship(String userId, String guid)
    Get a synonym relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermAnchor
    getTermAnchorRelationship(String userId, String guid)
    Get a Term Anchor Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization
    getTermCategorizationRelationship(String userId, String guid)
    Get a Term Categorization Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA
    getTermHasARelationship(String userId, String guid)
    Get a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy
    getTermTYPEDBYRelationship(String userId, String guid)
    Get a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation
    getTranslationRelationship(String userId, String guid)
    Get a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext
    getUsedInContextRelationship(String userId, String guid)
    Get a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue
    getValidValueRelationship(String userId, String guid)
    Get a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym
    replaceAntonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym)
    Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink
    replaceCategoryHierarchyLink(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink)
    Replace a CategoryHierarchyLink Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA
    replaceIsaRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa)
    Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf
    replaceIsATypeOf(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf)
    Replace anIsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated
    replaceIsATypeOfDeprecated(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf)
    Replace an IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm
    replacePreferredTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm)
    Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope
    replaceProjectScopeRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScopeRelationship)
    Replace a ProjectScope relationship which is a link between the project content and the project.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    replaceRelatedTerm(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm termRelatedTerm)
    Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm
    replaceReplacementTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm)
    Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym
    replaceSynonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym)
    Replace a Synonym relationship, which is a link between glossary terms that have the same meaning
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization
    replaceTermCategorizationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship)
    Replace a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA
    replaceTermHasARelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship)
    Replace a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy
    replaceTermTYPEDBYRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship)
    Replace an TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation
    replaceTranslationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation)
    Replace an Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext
    replaceUsedInContextRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext)
    Replace an UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue
    replaceValidValueRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue)
    Replace an ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym
    restoreAntonymRelationship(String userId, String guid)
    Restore a Antonym relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink
    restoreCategoryHierarchyLink(String userId, String guid)
    Restore a CategoryHierarchyLink Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA
    restoreIsaRelationship(String userId, String guid)
    Restore an is a relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf
    restoreIsATypeOf(String userId, String guid)
    Restore an is a type of relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated
    restoreIsaTypeOfDeprecated(String userId, String guid)
    Deprecated. 
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm
    restorePreferredTermRelationship(String userId, String guid)
    Restore a preferred term relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope
    restoreProjectScopeRelationship(String userId, String guid)
    Restore a ProjectScope relationship which is a link between the project content and the project.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    restoreRelatedTerm(String userId, String guid)
    Restore a Related Term relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    restoreRelatedTermRelationship(String userId, String guid)
    Restore a related term relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm
    restoreReplacementTermRelationship(String userId, String guid)
    Restore a replacement term relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym
    restoreSynonymRelationship(String userId, String guid)
    Restore a Synonym relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization
    restoreTermCategorizationRelationship(String userId, String guid)
    Restore a Term Categorization Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA
    restoreTermHasARelationship(String userId, String guid)
    Restore a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation
    restoreTranslationRelationship(String userId, String guid)
    Restore a Translation relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy
    restoreTypedByRelationship(String userId, String guid)
    Restore a typed by relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext
    restoreUsedInContextRelationship(String userId, String guid)
    Restore a Used in context relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue
    restoreValidValueRelationship(String userId, String guid)
    Restore a valid value relationship
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym
    updateAntonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym)
    Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink
    updateCategoryHierarchyLink(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink)
    Update a CategoryHierarchyLink Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA
    updateIsaRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa)
    Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf
    updateIsATypeOf(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf)
    Update a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated
    updateIsATypeOfDeprecated(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf)
    Update a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm
    updatePreferredTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm)
    Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope
    updateProjectScopeRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScopeRelationship)
    Update a ProjectScope relationship which is a link between the project content and the project.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm
    updateRelatedTerm(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm termRelatedTerm)
    Update a RelatedTerm Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm
    updateReplacementTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm)
    Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym
    updateSynonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym)
    Update a Synonym relationship which is a link between glossary terms that have the same meaning
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization
    updateTermCategorizationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship)
    Update a Term Categorization Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA
    updateTermHasARelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship)
    Update a Term HasA Relationship.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy
    updateTermTYPEDBYRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship)
    Update a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation
    updateTranslationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation)
    Update a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext
    updateUsedInContextRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext)
    Update a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue
    updateValidValueRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue)
    Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RelationshipHandler

      public RelationshipHandler(org.odpi.openmetadata.accessservices.subjectarea.client.relationships.SubjectAreaRelationshipClients subjectAreaRelationship)
      Constructor for the RelationshipHandler
      Parameters:
      subjectAreaRelationship - The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for terms. This is the same as the The SubjectAreaDefinition Open Metadata View Service (OMVS) API for terms.

  • Method Details

    • createTermHasARelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA createTermHasARelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Create a Term HasA Relationship. A relationship between a spine object and a spine attribute. Note that this method does not error if the relationship ends are not spine objects or spine attributes.

      Parameters:
      userId - userId under which the request is performed
      termHasARelationship - the HasA relationship
      Returns:
      the created term HasA relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getTermHasARelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA getTermHasARelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a Term HasA Relationship. A relationship between a spine object and a spine attribute.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Hasa relationship to get
      Returns:
      Hasa
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateTermHasARelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA updateTermHasARelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Term HasA Relationship. A relationship between a spine object and a spine attribute.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Hasa relationship
      termHasARelationship - the HasA relationship
      Returns:
      the updated term HasA relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property Server Exception

    • replaceTermHasARelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA replaceTermHasARelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA termHasARelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace a Term HasA Relationship.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Hasa relationship
      termHasARelationship - the HasA relationship
      Returns:
      the replaced term HasA relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteTermHasARelationship

      public void deleteTermHasARelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a Term HasA Relationship. A relationship between a spine object and a spine attribute. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Hasa relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreTermHasARelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.HasA restoreTermHasARelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Term HasA Relationship. A relationship between a spine object and a spine attribute.

      Restore allows the deleted has a relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the has a relationship to delete
      Returns:
      the restored has a relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createRelatedTerm

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm createRelatedTerm(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a RelatedTerm. A Related Term is a link between two similar Terms.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      relatedTermRelationship - the RelatedTerm relationship
      Returns:
      the created RelatedTerm relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property Server Exception

    • getRelatedTerm

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm getRelatedTerm(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a RelatedTerm. A Related Term is a link between two similar Terms.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the RelatedTerm relationship to get
      Returns:
      RelatedTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateRelatedTerm

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm updateRelatedTerm(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm termRelatedTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a RelatedTerm Relationship.

      Parameters:
      userId - userId under which the request is performed
      termRelatedTerm - the RelatedTerm relationship
      guid - guid of the RelatedTerm relationship
      Returns:
      the updated term RelatedTerm relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceRelatedTerm

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm replaceRelatedTerm(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm termRelatedTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the RelatedTerm relationship
      termRelatedTerm - the replacement related term relationship
      Returns:
      ReplacementTerm replaced related Term relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreRelatedTerm

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm restoreRelatedTerm(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Related Term relationship

      Restore allows the deleted Synonym relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the related term relationship to restore
      Returns:
      the restored related term relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteRelatedTerm

      public void deleteRelatedTerm(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a RelatedTerm. A Related Term is a link between two similar Terms. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the RelatedTerm relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreRelatedTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm restoreRelatedTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a related term relationship

      Restore allows the deleted related term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the related term relationship to delete
      Returns:
      the restored related term relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createSynonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym createSynonymRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a synonym relationship. A link between glossary terms that have the same meaning.

      Parameters:
      userId - userId under which the request is performed
      synonym - the Synonym relationship
      Returns:
      the created Synonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getSynonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym getSynonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a synonym relationship. A link between glossary terms that have the same meaning.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Synonym relationship to get
      Returns:
      Synonym
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateSynonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym updateSynonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Synonym relationship which is a link between glossary terms that have the same meaning

      Parameters:
      userId - userId under which the request is performed
      synonym - the Synonym relationship
      guid - guid of the Synonym relationship
      Returns:
      updated Synonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceSynonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym replaceSynonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace a Synonym relationship, which is a link between glossary terms that have the same meaning

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Synonym relationship
      synonym - the Synonym relationship
      Returns:
      replaced synonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteSynonymRelationship

      public void deleteSynonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a synonym relationship. A link between glossary terms that have the same meaning. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the synonym relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreSynonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym restoreSynonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Synonym relationship

      Restore allows the deleted Synonym relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Synonym relationship to delete
      Returns:
      the restored Synonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createAntonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym createAntonymRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a antonym relationship. A link between glossary terms that have the opposite meaning.

      Parameters:
      userId - userId under which the request is performed
      antonym - the Antonym relationship
      Returns:
      the created antonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getAntonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym getAntonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a antonym relationship. A link between glossary terms that have the opposite meaning.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Anonym relationship to get
      Returns:
      Antonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateAntonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym updateAntonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Antonym relationship which is a link between glossary terms that have the opposite meaning

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Anonym relationship
      antonym - the Antonym relationship
      Returns:
      Antonym updated antonym
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceAntonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym replaceAntonymRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Anonym relationship
      antonym - the antonym relationship
      Returns:
      Antonym replaced antonym
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteAntonymRelationship

      public void deleteAntonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a antonym relationship. A link between glossary terms that have the opposite meaning. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Antonym relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreAntonymRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym restoreAntonymRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Antonym relationship

      Restore allows the deleted Antonym relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Antonym relationship to delete
      Returns:
      the restored Antonym relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createTranslationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation createTranslationRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.

      Parameters:
      userId - userId under which the request is performed
      translation - the Translation relationship
      Returns:
      the created translation relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getTranslationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation getTranslationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Translation relationship to get
      Returns:
      Translation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateTranslationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation updateTranslationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Translation relationship
      translation - the Translation relationship
      Returns:
      Translation updated translation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceTranslationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation replaceTranslationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the Translation relationship
      translation - the translation relationship
      Returns:
      Translation replaced translation
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteTranslationRelationship

      public void deleteTranslationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Translation relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreTranslationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation restoreTranslationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Translation relationship

      Restore allows the deleted Translation relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Translation relationship to delete
      Returns:
      the restored Translation relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createUsedInContextRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext createUsedInContextRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.

      Parameters:
      userId - userId under which the request is performed
      usedInContext - the UsedInContext relationship
      Returns:
      the created usedInContext relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getUsedInContextRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext getUsedInContextRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the UsedInContext relationship to get
      Returns:
      UsedInContext
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateUsedInContextRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext updateUsedInContextRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the UsedInContext relationship
      usedInContext - the UsedInContext relationship
      Returns:
      UsedInContext updated usedInContext
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceUsedInContextRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext replaceUsedInContextRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the UsedInContext relationship
      usedInContext - the usedInContext relationship
      Returns:
      UsedInContext replaced usedInContext
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteUsedInContextRelationship

      public void deleteUsedInContextRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the UsedInContext relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreUsedInContextRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext restoreUsedInContextRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Used in context relationship

      Restore allows the deletedUsed in context relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Used in context relationship to delete
      Returns:
      the restored Used in context relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createPreferredTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm createPreferredTermRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.

      Parameters:
      userId - userId under which the request is performed
      preferredTerm - the PreferredTerm relationship
      Returns:
      the created preferredTerm relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getPreferredTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm getPreferredTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the PreferredTerm relationship to get
      Returns:
      PreferredTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updatePreferredTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm updatePreferredTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the PreferredTerm relationship
      preferredTerm - the PreferredTerm relationship
      Returns:
      PreferredTerm updated preferredTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replacePreferredTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm replacePreferredTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the PreferredTerm relationship
      preferredTerm - the preferredTerm relationship
      Returns:
      PreferredTerm replaced preferredTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deletePreferredTermRelationship

      public void deletePreferredTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a preferredTerm relationship, which is link to an alternative term that the organization prefer is used. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the PreferredTerm relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restorePreferredTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm restorePreferredTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a preferred term relationship

      Restore allows the deletedpreferred term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the preferred term relationship to delete
      Returns:
      the restored preferred term relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createValidValueRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue createValidValueRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

      Parameters:
      userId - userId under which the request is performed
      validValue - the ValidValue relationship
      Returns:
      the created validValue relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getValidValueRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue getValidValueRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ValidValue relationship to get
      Returns:
      ValidValue
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateValidValueRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue updateValidValueRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ValidValue relationship
      validValue - the ValidValue relationship
      Returns:
      ValidValue updated validValue
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceValidValueRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue replaceValidValueRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ValidValue relationship
      validValue - the validValue relationship
      Returns:
      ValidValue replaced validValue
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteValidValueRelationship

      public void deleteValidValueRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a validValue relationship, which is link between glossary terms where one defines one of the data values for the another. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ValidValue relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreValidValueRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue restoreValidValueRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a valid value relationship

      Restore allows the deletedvalid value relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the valid value relationship to delete
      Returns:
      the restored valid value relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createReplacementTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm createReplacementTermRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.

      Parameters:
      userId - userId under which the request is performed
      replacementTerm - the ReplacementTerm relationship
      Returns:
      the created replacementTerm relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getReplacementTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm getReplacementTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ReplacementTerm relationship to get
      Returns:
      ReplacementTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateReplacementTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm updateReplacementTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ReplacementTerm relationship
      replacementTerm - the ReplacementTerm relationship
      Returns:
      ReplacementTerm updated replacementTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceReplacementTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replaceReplacementTermRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ReplacementTerm relationship
      replacementTerm - the replacementTerm relationship
      Returns:
      ReplacementTerm replaced replacementTerm
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteReplacementTermRelationship

      public void deleteReplacementTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ReplacementTerm relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreReplacementTermRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm restoreReplacementTermRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a replacement term relationship

      Restore allows the deleted replacement term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the replacement term relationship to delete
      Returns:
      the restored replacement term relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createTermTYPEDBYRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy createTermTYPEDBYRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a TypedBy relationship, which is defines the relationship between a spine attribute and its type.

      Parameters:
      userId - userId under which the request is performed
      termTYPEDBYRelationship - the TypedBy relationship
      Returns:
      the created termTYPEDBYRelationship relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getTermTYPEDBYRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy getTermTYPEDBYRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the termTYPEDBYRelationship relationship to get
      Returns:
      TypedBy
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateTermTYPEDBYRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy updateTermTYPEDBYRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a TypedBy relationship, which is defines the relationship between a spine attribute and its type.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the TypedBy relationship
      termTYPEDBYRelationship - the TypedBy relationship
      Returns:
      TypedBy updated termTYPEDBYRelationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceTermTYPEDBYRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy replaceTermTYPEDBYRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy termTYPEDBYRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an TypedBy relationship, which is defines the relationship between a spine attribute and its type.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the TypedBy relationship
      termTYPEDBYRelationship - the termTYPEDBYRelationship relationship
      Returns:
      TypedBy replaced termTYPEDBYRelationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteTermTYPEDBYRelationship

      public void deleteTermTYPEDBYRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the termTYPEDBYRelationship relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreTypedByRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TypedBy restoreTypedByRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a typed by relationship

      Restore allows the deleted typed by relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the typed by relationship to delete
      Returns:
      the restored typed by relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createIsaRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA createIsaRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a Isa relationship, which is link between a more general glossary term and a more specific definition.

      Parameters:
      userId - userId under which the request is performed
      isa - the Isa relationship
      Returns:
      the created isa relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getIsaRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA getIsaRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a isa relationship, which is link between a more general glossary term and a more specific definition.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the isa relationship to get
      Returns:
      Isa
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateIsaRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA updateIsaRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Isa relationship, which is link between a more general glossary term and a more specific definition.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the isa relationship
      isa - the Isa relationship
      Returns:
      Isa updated isa
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceIsaRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA replaceIsaRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA isa) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the isa relationship
      isa - the isa relationship
      Returns:
      Isa replaced isa
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteIsaRelationship

      public void deleteIsaRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a isa relationship, which is link between a more general glossary term and a more specific definition. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the isa relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreIsaRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsA restoreIsaRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore an is a relationship

      Restore allows the deleted is a relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the is a relationship to delete
      Returns:
      the restored is a relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createIsATypeOfDeprecated

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated createIsATypeOfDeprecated(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      isATypeOf - the IsaTypeOf relationship
      Returns:
      the created IsaTypeOf relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getIsATypeOfDeprecated

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated getIsATypeOfDeprecated(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to get
      Returns:
      IsaTypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateIsATypeOfDeprecated

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated updateIsATypeOfDeprecated(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the IsaTypeOf relationship
      isATypeOf - the IsaTypeOf relationship
      Returns:
      IsaTypeOf updated IsaTypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceIsATypeOfDeprecated

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated replaceIsATypeOfDeprecated(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated isATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace an IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the IsaTypeOf relationship
      isATypeOf - the IsaTypeOf relationship
      Returns:
      IsaTypeOf replaced IsaTypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteIsATypeOfDeprecated

      public void deleteIsATypeOfDeprecated(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreIsaTypeOfDeprecated

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOfDeprecated restoreIsaTypeOfDeprecated(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Deprecated.
      Restore an is a type of deprecated relationship

      Restore allows the deleted is a type of relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the is a type of relationship to delete
      Returns:
      the restored is a type of relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createIsATypeOf

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf createIsATypeOf(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      IsATypeOf - the IsATypeOf relationship
      Returns:
      the createdIsATypeOf relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getIsATypeOf

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf getIsATypeOf(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsATypeOf relationship to get
      Returns:
      IsATypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateIsATypeOf

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf updateIsATypeOf(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the IsATypeOf relationship
      IsATypeOf - the IsATypeOf relationship
      Returns:
      IsATypeOf updatedIsATypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceIsATypeOf

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf replaceIsATypeOf(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf IsATypeOf) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace anIsATypeOf relationship, which is defines an inheritance relationship between two spine objects.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the IsATypeOf relationship
      IsATypeOf - the IsATypeOf relationship
      Returns:
      IsATypeOf replacedIsATypeOf
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteIsATypeOf

      public void deleteIsATypeOf(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a IsATypeOf relationship, which is defines an inheritance relationship between two spine objects. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsATypeOf relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreIsATypeOf

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.IsATypeOf restoreIsATypeOf(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore an is a type of relationship

      Restore allows the deleted is a type of relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the is a type of relationship to delete
      Returns:
      the restored is a type of relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createTermCategorizationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization createTermCategorizationRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. Note that this method does not error if the relationship ends are not spine objects or spine attributes.

      Parameters:
      userId - userId under which the request is performed
      termCategorizationRelationship - the term categorization relationship
      Returns:
      the created term categorization relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getTermCategorizationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization getTermCategorizationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the TermCategorizationRelationship relationship to get
      Returns:
      TermCategorizationRelationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateTermCategorizationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization updateTermCategorizationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the TermCategorizationRelationship
      termCategorizationRelationship - the term categorization relationship
      Returns:
      the updated term categorization relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceTermCategorizationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization replaceTermCategorizationRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization termCategorizationRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace a Term HasA Relationship.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the TermCategorizationRelationship
      termCategorizationRelationship - the term categorization relationship
      Returns:
      the replaced term categorization relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteTermCategorizationRelationship

      public void deleteTermCategorizationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. * A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the TermCategorizationRelationship relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreTermCategorizationRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Categorization restoreTermCategorizationRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.

      Restore allows the deleted Term Categorization relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the Term Categorization relationship to delete
      Returns:
      the restored has a relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getTermAnchorRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermAnchor getTermAnchorRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the TermAnchorRelationship relationship to get
      Returns:
      TermAnchorRelationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getCategoryAnchorRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryAnchor getCategoryAnchorRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryAnchorRelationship relationship to get
      Returns:
      CategoryAnchorRelationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createProjectScopeRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope createProjectScopeRelationship(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScope) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a ProjectScope relationship. A link between the project content and the project.

      Parameters:
      userId - userId under which the request is performed
      projectScope - the ProjectScope relationship
      Returns:
      the created ProjectScope relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getProjectScopeRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope getProjectScopeRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a ProjectScope relationship. A link between the project content and the project.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ProjectScope relationship to get
      Returns:
      ProjectScope
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateProjectScopeRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope updateProjectScopeRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScopeRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update a ProjectScope relationship which is a link between the project content and the project.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ProjectScope relationship
      projectScopeRelationship - the ProjectScope relationship
      Returns:
      updated ProjectScope relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceProjectScopeRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope replaceProjectScopeRelationship(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope projectScopeRelationship) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Replace a ProjectScope relationship which is a link between the project content and the project.

      Parameters:
      userId - userId under which the request is performed
      guid - guid of the ProjectScope relationship
      projectScopeRelationship - the ProjectScope relationship
      Returns:
      replaced ProjectScope relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteProjectScopeRelationship

      public void deleteProjectScopeRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a ProjectScope relationship. A link between the project content and the project. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ProjectScope relationship to delete

      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreProjectScopeRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ProjectScope restoreProjectScopeRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Restore a ProjectScope relationship which is a link between the project content and the project.

      Restore allows the deleted ProjectScope relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ProjectScope relationship to restore
      Returns:
      the restored ProjectScope relationship
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • createCategoryHierarchyLink

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink createCategoryHierarchyLink(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Create a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      categoryHierarchyLink - the CategoryHierarchyLink relationship
      Returns:
      CategoryHierarchyLink the created CategoryHierarchyLink
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getCategoryHierarchyLink

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink getCategoryHierarchyLink(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to get
      Returns:
      the CategoryHierarchyLink relationship with the requested guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • updateCategoryHierarchyLink

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink updateCategoryHierarchyLink(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      userId - userId under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to update
      categoryHierarchyLink - the CategoryHierarchyLink relationship
      Returns:
      the updated categoryHierarchyLink
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • replaceCategoryHierarchyLink

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink replaceCategoryHierarchyLink(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink categoryHierarchyLink) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Replace a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      userId - userId under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to update
      categoryHierarchyLink - the CategoryHierarchyLink relationship
      Returns:
      the replaced categoryHierarchyLink
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • deleteCategoryHierarchyLink

      public void deleteCategoryHierarchyLink(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Delete a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink relationship to delete
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • restoreCategoryHierarchyLink

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.CategoryHierarchyLink restoreCategoryHierarchyLink(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Restore a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.

      Restore allows the deleted CategoryHierarchyLink Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to restore
      Returns:
      the restored CategoryHierarchyLink
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception

    • getSemanticAssignmentRelationship

      public org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.SemanticAssignment getSemanticAssignmentRelationship(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
      Parameters:
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the SemanticAssignment relationship to get
      Returns:
      the SemanticAssignment relationship with the requested guid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - Property server exception