RelationshipHandler (glossary-author-view-server 1.8 API)

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 and Description

RelationshipHandler(SubjectAreaRelationship subjectAreaRelationship)
Constructor for the RelationshipHandler

Constructors
Constructor and Description
`RelationshipHandler(SubjectAreaRelationship subjectAreaRelationship)` Constructor for the RelationshipHandler

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Antonym`	`createAntonymRelationship(String userId, Antonym antonym)` Create a antonym relationship.
`CategoryAnchor`	`createCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Create a Category Anchor Relationship.
`Isa`	`createIsaRelationship(String userId, Isa isa)` Create a Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`createPreferredTermRelationship(String userId, PreferredTerm preferredTerm)` Create a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`createProjectScopeRelationship(String userId, ProjectScope projectScope)` Create a ProjectScope relationship.
`RelatedTerm`	`createRelatedTerm(String userId, RelatedTerm relatedTermRelationship)` Create a RelatedTerm.
`ReplacementTerm`	`createReplacementTermRelationship(String userId, ReplacementTerm replacementTerm)` Create a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`createSynonymRelationship(String userId, Synonym synonym)` Create a synonym relationship.
`TermAnchor`	`createTermAnchorRelationship(String userId, TermAnchor termAnchorRelationship)` Create a Term Anchor Relationship.
`Categorization`	`createTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Create a Term Categorization Relationship.
`Hasa`	`createTermHASARelationship(String userId, Hasa termHASARelationship)` Create a Term HASA Relationship.
`IsaTypeOf`	`createTermISATypeOFRelationship(String userId, IsaTypeOf isATypeOf)` Create a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`createTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Create a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`createTranslationRelationship(String userId, Translation translation)` Create a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`createUsedInContextRelationship(String userId, 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.
`ValidValue`	`createValidValueRelationship(String userId, ValidValue validValue)` Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`deleteAntonymRelationship(String userId, String guid)` Delete a antonym relationship.
`CategoryAnchor`	`deleteCategoryAnchorRelationship(String userId, String guid)` Delete a Category Anchor Relationship.
`Isa`	`deleteIsaRelationship(String userId, String guid)` Delete a isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`deletePreferredTermRelationship(String userId, String guid)` Delete a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`deleteProjectScopeRelationship(String userId, String guid)` Delete a ProjectScope relationship.
`RelatedTerm`	`deleteRelatedTerm(String userId, String guid)` Delete a RelatedTerm.
`ReplacementTerm`	`deleteReplacementTermRelationship(String userId, String guid)` Delete a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`deleteSynonymRelationship(String userId, String guid)` Delete a synonym relationship.
`TermAnchor`	`deleteTermAnchorRelationship(String userId, String guid)` Delete a Term Anchor Relationship.
`Categorization`	`deleteTermCategorizationRelationship(String userId, String guid)` Delete a Term Categorization Relationship.
`Hasa`	`deleteTermHASARelationship(String userId, String guid)` Delete a Term HASA Relationship.
`IsaTypeOf`	`deleteTermISATypeOFRelationship(String userId, String guid)` Delete a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`deleteTermTYPEDBYRelationship(String userId, String guid)` Delete a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`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.
`UsedInContext`	`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.
`ValidValue`	`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.
`Antonym`	`getAntonymRelationship(String userId, String guid)` Get a antonym relationship.
`CategoryAnchor`	`getCategoryAnchorRelationship(String userId, String guid)` Get a Category Anchor Relationship.
`Isa`	`getIsaRelationship(String userId, String guid)` Get a isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`getPreferredTermRelationship(String userId, String guid)` Get a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`getProjectScopeRelationship(String userId, String guid)` Get a ProjectScope relationship.
`RelatedTerm`	`getRelatedTerm(String userId, String guid)` Get a RelatedTerm.
`ReplacementTerm`	`getReplacementTermRelationship(String userId, String guid)` Get a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`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.
`Synonym`	`getSynonymRelationship(String userId, String guid)` Get a synonym relationship.
`TermAnchor`	`getTermAnchorRelationship(String userId, String guid)` Get a Term Anchor Relationship.
`Categorization`	`getTermCategorizationRelationship(String userId, String guid)` Get a Term Categorization Relationship.
`Hasa`	`getTermHASARelationship(String userId, String guid)` Get a Term HASA Relationship.
`IsaTypeOf`	`getTermISATypeOFRelationship(String userId, String guid)` Get a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`getTermTYPEDBYRelationship(String userId, String guid)` Get a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`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.
`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.
`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.
`void`	`purgeAntonymRelationship(String userId, String guid)` Purge a antonym relationship.
`void`	`purgeCategoryAnchorRelationship(String userId, String guid)` Purge a Category Anchor Relationship.
`void`	`purgeIsaRelationship(String userId, String guid)` Purge a isa relationship, which is link between a more general glossary term and a more specific definition.
`void`	`purgePreferredTermRelationship(String userId, String guid)` Purge a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`void`	`purgeProjectScopeRelationship(String userId, String guid)` Purge a ProjectScope relationship.
`void`	`purgeRelatedTerm(String userId, String guid)` Purge a RelatedTerm.
`void`	`purgeReplacementTermRelationship(String userId, String guid)` Purge a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`void`	`purgeSynonymRelationship(String userId, String guid)` Purge a synonym relationship.
`void`	`purgeTermAnchorRelationship(String userId, String guid)` Purge a Term Anchor Relationship.
`void`	`purgeTermCategorizationRelationship(String userId, String guid)` Purge a Term Categorization Relationship.
`void`	`purgeTermHASARelationship(String userId, String guid)` Purge a Term HASA Relationship.
`void`	`purgeTermISATypeOFRelationship(String userId, String guid)` Purge a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`void`	`purgeTermTYPEDBYRelationship(String userId, String guid)` Purge a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`void`	`purgeTranslationRelationship(String userId, String guid)` Purge a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`void`	`purgeUsedInContextRelationship(String userId, String guid)` Purge a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`void`	`purgeValidValueRelationship(String userId, String guid)` Purge a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`replaceAntonymRelationship(String userId, Antonym antonym)` Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchor`	`replaceCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Replace a Category Anchor Relationship.
`Isa`	`replaceIsaRelationship(String userId, Isa isa)` Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`replacePreferredTermRelationship(String userId, PreferredTerm preferredTerm)` Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`replaceProjectScopeRelationship(String userId, ProjectScope projectScopeRelationship)` Replace a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`replaceRelatedTerm(String userId, RelatedTerm termRelatedTerm)` Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`ReplacementTerm`	`replaceReplacementTermRelationship(String userId, ReplacementTerm replacementTerm)` Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`replaceSynonymRelationship(String userId, Synonym synonym)` Replace a Synonym relationship, which is a link between glossary terms that have the same meaning
`TermAnchor`	`replaceTermAnchorRelationship(String userId, TermAnchor termAnchorRelationship)` Replace a Term Anchor Relationship.
`Categorization`	`replaceTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Replace a Term HASA Relationship.
`Hasa`	`replaceTermHASARelationship(String userId, Hasa termHASARelationship)` Replace a Term HASA Relationship.
`IsaTypeOf`	`replaceTermISATypeOFRelationship(String userId, IsaTypeOf isATypeOf)` Replace an IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`replaceTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Replace an TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`replaceTranslationRelationship(String userId, Translation translation)` Replace an Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`replaceUsedInContextRelationship(String userId, 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.
`ValidValue`	`replaceValidValueRelationship(String userId, ValidValue validValue)` Replace an ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`restoreAntonymRelationship(String userId, String guid)` Restore a Antonym relationship
`CategoryAnchor`	`restoreCategoryAnchorRelationship(String userId, String guid)` Restore a Category Anchor Relationship.
`Isa`	`restoreIsaRelationship(String userId, String guid)` Restore an is a relationship
`IsaTypeOf`	`restoreIsaTypeOfRelationship(String userId, String guid)` Restore an is a type of relationship
`PreferredTerm`	`restorePreferredTermRelationship(String userId, String guid)` Restore a preferred term relationship
`ProjectScope`	`restoreProjectScopeRelationship(String userId, String guid)` Restore a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`restoreRelatedTerm(String userId, String guid)` Restore a Related Term relationship
`RelatedTerm`	`restoreRelatedTermRelationship(String userId, String guid)` Restore a related term relationship
`ReplacementTerm`	`restoreReplacementTermRelationship(String userId, String guid)` Restore a replacement term relationship
`Synonym`	`restoreSynonymRelationship(String userId, String guid)` Restore a Synonym relationship
`TermAnchor`	`restoreTermAnchorRelationship(String userId, String guid)` Restore a Term Anchor Relationship.
`Categorization`	`restoreTermCategorizationRelationship(String userId, String guid)` Restore a Term Categorization Relationship.
`Hasa`	`restoreTermHASARelationship(String userId, String guid)` Restore a Term HASA Relationship.
`Translation`	`restoreTranslationRelationship(String userId, String guid)` Restore a Translation relationship
`TypedBy`	`restoreTypedByRelationship(String userId, String guid)` Restore a typed by relationship
`UsedInContext`	`restoreUsedInContextRelationship(String userId, String guid)` Restore a Used in context relationship
`ValidValue`	`restoreValidValueRelationship(String userId, String guid)` Restore a valid value relationship
`Antonym`	`updateAntonymRelationship(String userId, Antonym antonym)` Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchor`	`updateCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Update a Category Anchor Relationship.
`Isa`	`updateIsaRelationship(String userId, Isa isa)` Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`updatePreferredTermRelationship(String userId, PreferredTerm preferredTerm)` Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`updateProjectScopeRelationship(String userId, ProjectScope projectScopeRelationship)` Update a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`updateRelatedTerm(String userId, RelatedTerm termRelatedTerm)` Update a RelatedTerm Relationship.
`ReplacementTerm`	`updateReplacementTermRelationship(String userId, ReplacementTerm replacementTerm)` Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`updateSynonymRelationship(String userId, Synonym synonym)` Update a Synonym relationship which is a link between glossary terms that have the same meaning
`TermAnchor`	`updateTermAnchorRelationship(String userId, TermAnchor termAnchorRelationship)` Update a Term Anchor Relationship.
`Categorization`	`updateTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Update a Term Categorization Relationship.
`Hasa`	`updateTermHASARelationship(String userId, Hasa termHASARelationship)` Update a Term HASA Relationship.
`IsaTypeOf`	`updateTermISATypeOFRelationship(String userId, IsaTypeOf isATypeOf)` Update a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`updateTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Update a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`updateTranslationRelationship(String userId, Translation translation)` Update a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`updateUsedInContextRelationship(String userId, 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.
`ValidValue`	`updateValidValueRelationship(String userId, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RelationshipHandler
```
public RelationshipHandler(SubjectAreaRelationship 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 Detail
  - createTermHASARelationship
```
public Hasa createTermHASARelationship(String userId,
                                       Hasa termHASARelationship)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       MetadataServerUncontactableException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermHASARelationship
```
public Hasa getTermHASARelationship(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    MetadataServerUncontactableException,
                                    UserNotAuthorizedException,
                                    UnexpectedResponseException,
                                    UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermHASARelationship
```
public Hasa updateTermHASARelationship(String userId,
                                       Hasa termHASARelationship)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       MetadataServerUncontactableException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException
```
    Update a Term HASA Relationship. A relationship between a spine object and a spine attribute.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the updated term HASA relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermHASARelationship
```
public Hasa replaceTermHASARelationship(String userId,
                                        Hasa termHASARelationship)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException,
                                        UnrecognizedGUIDException
```
    Replace a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the replaced term HASA relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermHASARelationship
```
public Hasa deleteTermHASARelationship(String userId,
                                       String guid)
                                throws InvalidParameterException,
                                       MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       UnrecognizedGUIDException,
                                       FunctionNotSupportedException,
                                       RelationshipNotDeletedException,
                                       UnexpectedResponseException
```
    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
    
    Returns:
    
    Deleted Hasa
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermHASARelationship
```
public void purgeTermHASARelationship(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      RelationshipNotPurgedException,
                                      UnrecognizedGUIDException,
                                      MetadataServerUncontactableException,
                                      UnexpectedResponseException
```
    Purge a Term HASA Relationship. A relationship between a spine object and a spine attribute. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Hasa relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermHASARelationship
```
public Hasa restoreTermHASARelationship(String userId,
                                        String guid)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException,
                                        UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createRelatedTerm
```
public RelatedTerm createRelatedTerm(String userId,
                                     RelatedTerm relatedTermRelationship)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     MetadataServerUncontactableException,
                                     UnexpectedResponseException,
                                     UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getRelatedTerm
```
public RelatedTerm getRelatedTerm(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateRelatedTerm
```
public RelatedTerm updateRelatedTerm(String userId,
                                     RelatedTerm termRelatedTerm)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     MetadataServerUncontactableException,
                                     UnexpectedResponseException,
                                     UnrecognizedGUIDException
```
    Update a RelatedTerm Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termRelatedTerm - the RelatedTerm relationship
    
    Returns:
    
    the updated term RelatedTerm relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceRelatedTerm
```
public RelatedTerm replaceRelatedTerm(String userId,
                                      RelatedTerm termRelatedTerm)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      MetadataServerUncontactableException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException
```
    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
    
    termRelatedTerm - the replacement related term relationship
    
    Returns:
    
    ReplacementTerm replaced related Term relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreRelatedTerm
```
public RelatedTerm restoreRelatedTerm(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      MetadataServerUncontactableException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteRelatedTerm
```
public RelatedTerm deleteRelatedTerm(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     UnrecognizedGUIDException,
                                     FunctionNotSupportedException,
                                     RelationshipNotDeletedException,
                                     UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted RelatedTerm relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeRelatedTerm
```
public void purgeRelatedTerm(String userId,
                             String guid)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             RelationshipNotPurgedException,
                             UnrecognizedGUIDException,
                             MetadataServerUncontactableException,
                             UnexpectedResponseException
```
    Purge a RelatedTerm. A Related Term is a link between two similar Terms. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreRelatedTermRelationship
```
public RelatedTerm restoreRelatedTermRelationship(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  MetadataServerUncontactableException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createSynonymRelationship
```
public Synonym createSynonymRelationship(String userId,
                                         Synonym synonym)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getSynonymRelationship
```
public Synonym getSynonymRelationship(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateSynonymRelationship
```
public Synonym updateSynonymRelationship(String userId,
                                         Synonym synonym)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    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
    
    Returns:
    
    updated Synonym relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceSynonymRelationship
```
public Synonym replaceSynonymRelationship(String userId,
                                          Synonym synonym)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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
    
    synonym - the Synonym relationship
    
    Returns:
    
    replaced synonym relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteSynonymRelationship
```
public Synonym deleteSynonymRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UnrecognizedGUIDException,
                                         UserNotAuthorizedException,
                                         FunctionNotSupportedException,
                                         RelationshipNotDeletedException,
                                         UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted Synonym relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeSynonymRelationship
```
public void purgeSynonymRelationship(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     RelationshipNotPurgedException,
                                     UnrecognizedGUIDException,
                                     MetadataServerUncontactableException,
                                     UnexpectedResponseException
```
    Purge a synonym relationship. A link between glossary terms that have the same meaning. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreSynonymRelationship
```
public Synonym restoreSynonymRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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 restore
    
    Returns:
    
    the restored Synonym relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createAntonymRelationship
```
public Antonym createAntonymRelationship(String userId,
                                         Antonym antonym)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getAntonymRelationship
```
public Antonym getAntonymRelationship(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateAntonymRelationship
```
public Antonym updateAntonymRelationship(String userId,
                                         Antonym antonym)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    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
    
    antonym - the Antonym relationship
    
    Returns:
    
    Antonym updated antonym
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceAntonymRelationship
```
public Antonym replaceAntonymRelationship(String userId,
                                          Antonym antonym)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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
    
    antonym - the antonym relationship
    
    Returns:
    
    Antonym replaced antonym
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteAntonymRelationship
```
public Antonym deleteAntonymRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnrecognizedGUIDException,
                                         FunctionNotSupportedException,
                                         RelationshipNotDeletedException,
                                         UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted Antonym
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeAntonymRelationship
```
public void purgeAntonymRelationship(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     RelationshipNotPurgedException,
                                     UnrecognizedGUIDException,
                                     MetadataServerUncontactableException,
                                     UnexpectedResponseException
```
    Purge a antonym relationship. A link between glossary terms that have the opposite meaning. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreAntonymRelationship
```
public Antonym restoreAntonymRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTranslationRelationship
```
public Translation createTranslationRelationship(String userId,
                                                 Translation translation)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTranslationRelationship
```
public Translation getTranslationRelationship(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTranslationRelationship
```
public Translation updateTranslationRelationship(String userId,
                                                 Translation translation)
                                          throws InvalidParameterException,
                                                 MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException
```
    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
    
    translation - the Translation relationship
    
    Returns:
    
    Translation updated translation
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTranslationRelationship
```
public Translation replaceTranslationRelationship(String userId,
                                                  Translation translation)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    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
    
    translation - the translation relationship
    
    Returns:
    
    Translation replaced translation
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTranslationRelationship
```
public Translation deleteTranslationRelationship(String userId,
                                                 String guid)
                                          throws InvalidParameterException,
                                                 MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 UnrecognizedGUIDException,
                                                 FunctionNotSupportedException,
                                                 RelationshipNotDeletedException,
                                                 UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted Translation
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTranslationRelationship
```
public void purgeTranslationRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         RelationshipNotPurgedException,
                                         UnrecognizedGUIDException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException
```
    Purge a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTranslationRelationship
```
public Translation restoreTranslationRelationship(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  MetadataServerUncontactableException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createUsedInContextRelationship
```
public UsedInContext createUsedInContextRelationship(String userId,
                                                     UsedInContext usedInContext)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getUsedInContextRelationship
```
public UsedInContext getUsedInContextRelationship(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateUsedInContextRelationship
```
public UsedInContext updateUsedInContextRelationship(String userId,
                                                     UsedInContext usedInContext)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException
```
    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
    
    usedInContext - the UsedInContext relationship
    
    Returns:
    
    UsedInContext updated usedInContext
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceUsedInContextRelationship
```
public UsedInContext replaceUsedInContextRelationship(String userId,
                                                      UsedInContext usedInContext)
                                               throws InvalidParameterException,
                                                      MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    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
    
    usedInContext - the usedInContext relationship
    
    Returns:
    
    UsedInContext replaced usedInContext
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteUsedInContextRelationship
```
public UsedInContext deleteUsedInContextRelationship(String userId,
                                                     String guid)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnrecognizedGUIDException,
                                                     FunctionNotSupportedException,
                                                     RelationshipNotDeletedException,
                                                     UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted UsedInContext
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeUsedInContextRelationship
```
public void purgeUsedInContextRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           RelationshipNotPurgedException,
                                           UnrecognizedGUIDException,
                                           MetadataServerUncontactableException,
                                           UnexpectedResponseException
```
    Purge a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the UsedInContext relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreUsedInContextRelationship
```
public UsedInContext restoreUsedInContextRelationship(String userId,
                                                      String guid)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      MetadataServerUncontactableException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createPreferredTermRelationship
```
public PreferredTerm createPreferredTermRelationship(String userId,
                                                     PreferredTerm preferredTerm)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getPreferredTermRelationship
```
public PreferredTerm getPreferredTermRelationship(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updatePreferredTermRelationship
```
public PreferredTerm updatePreferredTermRelationship(String userId,
                                                     PreferredTerm preferredTerm)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException
```
    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
    
    preferredTerm - the PreferredTerm relationship
    
    Returns:
    
    PreferredTerm updated preferredTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replacePreferredTermRelationship
```
public PreferredTerm replacePreferredTermRelationship(String userId,
                                                      PreferredTerm preferredTerm)
                                               throws InvalidParameterException,
                                                      MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    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
    
    preferredTerm - the preferredTerm relationship
    
    Returns:
    
    PreferredTerm replaced preferredTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deletePreferredTermRelationship
```
public PreferredTerm deletePreferredTermRelationship(String userId,
                                                     String guid)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnrecognizedGUIDException,
                                                     FunctionNotSupportedException,
                                                     RelationshipNotDeletedException,
                                                     UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted PreferredTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgePreferredTermRelationship
```
public void purgePreferredTermRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           RelationshipNotPurgedException,
                                           UnrecognizedGUIDException,
                                           MetadataServerUncontactableException,
                                           UnexpectedResponseException
```
    Purge a preferredTerm relationship, which is link to an alternative term that the organization prefer is used. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the PreferredTerm relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restorePreferredTermRelationship
```
public PreferredTerm restorePreferredTermRelationship(String userId,
                                                      String guid)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      MetadataServerUncontactableException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createValidValueRelationship
```
public ValidValue createValidValueRelationship(String userId,
                                               ValidValue validValue)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getValidValueRelationship
```
public ValidValue getValidValueRelationship(String userId,
                                            String guid)
                                     throws InvalidParameterException,
                                            MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            UnexpectedResponseException,
                                            UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateValidValueRelationship
```
public ValidValue updateValidValueRelationship(String userId,
                                               ValidValue validValue)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException
```
    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
    
    validValue - the ValidValue relationship
    
    Returns:
    
    ValidValue updated validValue
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceValidValueRelationship
```
public ValidValue replaceValidValueRelationship(String userId,
                                                ValidValue validValue)
                                         throws InvalidParameterException,
                                                MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException
```
    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
    
    validValue - the validValue relationship
    
    Returns:
    
    ValidValue replaced validValue
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteValidValueRelationship
```
public ValidValue deleteValidValueRelationship(String userId,
                                               String guid)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnrecognizedGUIDException,
                                               FunctionNotSupportedException,
                                               RelationshipNotDeletedException,
                                               UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted ValidValue
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeValidValueRelationship
```
public void purgeValidValueRelationship(String userId,
                                        String guid)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        RelationshipNotPurgedException,
                                        UnrecognizedGUIDException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException
```
    Purge a validValue relationship, which is link between glossary terms where one defines one of the data values for the another. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ValidValue relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreValidValueRelationship
```
public ValidValue restoreValidValueRelationship(String userId,
                                                String guid)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createReplacementTermRelationship
```
public ReplacementTerm createReplacementTermRelationship(String userId,
                                                         ReplacementTerm replacementTerm)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         MetadataServerUncontactableException,
                                                         UnexpectedResponseException,
                                                         UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getReplacementTermRelationship
```
public ReplacementTerm getReplacementTermRelationship(String userId,
                                                      String guid)
                                               throws InvalidParameterException,
                                                      MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateReplacementTermRelationship
```
public ReplacementTerm updateReplacementTermRelationship(String userId,
                                                         ReplacementTerm replacementTerm)
                                                  throws InvalidParameterException,
                                                         MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         UnexpectedResponseException,
                                                         UnrecognizedGUIDException
```
    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
    
    replacementTerm - the ReplacementTerm relationship
    
    Returns:
    
    ReplacementTerm updated replacementTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceReplacementTermRelationship
```
public ReplacementTerm replaceReplacementTermRelationship(String userId,
                                                          ReplacementTerm replacementTerm)
                                                   throws InvalidParameterException,
                                                          MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          UnexpectedResponseException,
                                                          UnrecognizedGUIDException
```
    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
    
    replacementTerm - the replacementTerm relationship
    
    Returns:
    
    ReplacementTerm replaced replacementTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteReplacementTermRelationship
```
public ReplacementTerm deleteReplacementTermRelationship(String userId,
                                                         String guid)
                                                  throws InvalidParameterException,
                                                         MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         UnrecognizedGUIDException,
                                                         FunctionNotSupportedException,
                                                         RelationshipNotDeletedException,
                                                         UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted ReplacementTerm
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeReplacementTermRelationship
```
public void purgeReplacementTermRelationship(String userId,
                                             String guid)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             RelationshipNotPurgedException,
                                             UnrecognizedGUIDException,
                                             MetadataServerUncontactableException,
                                             UnexpectedResponseException
```
    Purge a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ReplacementTerm relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreReplacementTermRelationship
```
public ReplacementTerm restoreReplacementTermRelationship(String userId,
                                                          String guid)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          MetadataServerUncontactableException,
                                                          UnexpectedResponseException,
                                                          UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermTYPEDBYRelationship
```
public TypedBy createTermTYPEDBYRelationship(String userId,
                                             TypedBy termTYPEDBYRelationship)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             MetadataServerUncontactableException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermTYPEDBYRelationship
```
public TypedBy getTermTYPEDBYRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermTYPEDBYRelationship
```
public TypedBy updateTermTYPEDBYRelationship(String userId,
                                             TypedBy termTYPEDBYRelationship)
                                      throws InvalidParameterException,
                                             MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException
```
    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
    
    termTYPEDBYRelationship - the TypedBy relationship
    
    Returns:
    
    TypedBy updated termTYPEDBYRelationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermTYPEDBYRelationship
```
public TypedBy replaceTermTYPEDBYRelationship(String userId,
                                              TypedBy termTYPEDBYRelationship)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException
```
    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
    
    termTYPEDBYRelationship - the termTYPEDBYRelationship relationship
    
    Returns:
    
    TypedBy replaced termTYPEDBYRelationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermTYPEDBYRelationship
```
public TypedBy deleteTermTYPEDBYRelationship(String userId,
                                             String guid)
                                      throws InvalidParameterException,
                                             MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             UnrecognizedGUIDException,
                                             FunctionNotSupportedException,
                                             RelationshipNotDeletedException,
                                             UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted TypedBy
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermTYPEDBYRelationship
```
public void purgeTermTYPEDBYRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         RelationshipNotPurgedException,
                                         UnrecognizedGUIDException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException
```
    Purge a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TypedBy relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTypedByRelationship
```
public TypedBy restoreTypedByRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createIsaRelationship
```
public Isa createIsaRelationship(String userId,
                                 Isa isa)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException,
                                 UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getIsaRelationship
```
public Isa getIsaRelationship(String userId,
                              String guid)
                       throws InvalidParameterException,
                              MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              UnexpectedResponseException,
                              UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateIsaRelationship
```
public Isa updateIsaRelationship(String userId,
                                 Isa isa)
                          throws InvalidParameterException,
                                 MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 UnexpectedResponseException,
                                 UnrecognizedGUIDException
```
    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
    
    isa - the Isa relationship
    
    Returns:
    
    Isa updated isa
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceIsaRelationship
```
public Isa replaceIsaRelationship(String userId,
                                  Isa isa)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException
```
    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
    
    isa - the isa relationship
    
    Returns:
    
    Isa replaced isa
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteIsaRelationship
```
public Isa deleteIsaRelationship(String userId,
                                 String guid)
                          throws InvalidParameterException,
                                 MetadataServerUncontactableException,
                                 UserNotAuthorizedException,
                                 UnrecognizedGUIDException,
                                 FunctionNotSupportedException,
                                 RelationshipNotDeletedException,
                                 UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted Isa
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeIsaRelationship
```
public void purgeIsaRelationship(String userId,
                                 String guid)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 RelationshipNotPurgedException,
                                 UnrecognizedGUIDException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException
```
    Purge a isa relationship, which is link between a more general glossary term and a more specific definition. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Isa relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreIsaRelationship
```
public Isa restoreIsaRelationship(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  MetadataServerUncontactableException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermISATypeOFRelationship
```
public IsaTypeOf createTermISATypeOFRelationship(String userId,
                                                 IsaTypeOf isATypeOf)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermISATypeOFRelationship
```
public IsaTypeOf getTermISATypeOFRelationship(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermISATypeOFRelationship
```
public IsaTypeOf updateTermISATypeOFRelationship(String userId,
                                                 IsaTypeOf isATypeOf)
                                          throws InvalidParameterException,
                                                 MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException
```
    Update 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:
    
    IsaTypeOf updated IsaTypeOf
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermISATypeOFRelationship
```
public IsaTypeOf replaceTermISATypeOFRelationship(String userId,
                                                  IsaTypeOf isATypeOf)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException
```
    Replace an 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:
    
    IsaTypeOf replaced IsaTypeOf
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermISATypeOFRelationship
```
public IsaTypeOf deleteTermISATypeOFRelationship(String userId,
                                                 String guid)
                                          throws InvalidParameterException,
                                                 MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 UnrecognizedGUIDException,
                                                 FunctionNotSupportedException,
                                                 RelationshipNotDeletedException,
                                                 UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted IsaTypeOf
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted. Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermISATypeOFRelationship
```
public void purgeTermISATypeOFRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           RelationshipNotPurgedException,
                                           UnrecognizedGUIDException,
                                           MetadataServerUncontactableException,
                                           UnexpectedResponseException
```
    Purge a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the IsaTypeOf relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreIsaTypeOfRelationship
```
public IsaTypeOf restoreIsaTypeOfRelationship(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              MetadataServerUncontactableException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermCategorizationRelationship
```
public Categorization createTermCategorizationRelationship(String userId,
                                                           Categorization termCategorizationRelationship)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           UnexpectedResponseException,
                                                           UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermCategorizationRelationship
```
public Categorization getTermCategorizationRelationship(String userId,
                                                        String guid)
                                                 throws InvalidParameterException,
                                                        MetadataServerUncontactableException,
                                                        UserNotAuthorizedException,
                                                        UnexpectedResponseException,
                                                        UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermCategorizationRelationship
```
public Categorization updateTermCategorizationRelationship(String userId,
                                                           Categorization termCategorizationRelationship)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           MetadataServerUncontactableException,
                                                           UnexpectedResponseException,
                                                           UnrecognizedGUIDException
```
    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
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the updated term categorization relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermCategorizationRelationship
```
public Categorization replaceTermCategorizationRelationship(String userId,
                                                            Categorization termCategorizationRelationship)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            MetadataServerUncontactableException,
                                                            UnexpectedResponseException,
                                                            UnrecognizedGUIDException
```
    Replace a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the replaced term categorization relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermCategorizationRelationship
```
public Categorization deleteTermCategorizationRelationship(String userId,
                                                           String guid)
                                                    throws InvalidParameterException,
                                                           MetadataServerUncontactableException,
                                                           UserNotAuthorizedException,
                                                           UnrecognizedGUIDException,
                                                           FunctionNotSupportedException,
                                                           RelationshipNotDeletedException,
                                                           UnexpectedResponseException
```
    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
    
    Returns:
    
    Deleted TermCategorizationRelationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermCategorizationRelationship
```
public void purgeTermCategorizationRelationship(String userId,
                                                String guid)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                RelationshipNotPurgedException,
                                                UnrecognizedGUIDException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException
```
    Purge a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermCategorizationRelationship
```
public Categorization restoreTermCategorizationRelationship(String userId,
                                                            String guid)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            MetadataServerUncontactableException,
                                                            UnexpectedResponseException,
                                                            UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermAnchorRelationship
```
public TermAnchor createTermAnchorRelationship(String userId,
                                               TermAnchor termAnchorRelationship)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException
```
    Create a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. This method does not error if the relationship ends are not spine objects or spine attributes. Terms created using the Glossary author OMVS cannot be created without a glossary and there can only be one glossary associated with a Term. This method is to allow glossaries to be associated with Terms that have not been created via the Glossary Author OMVS or Subject Area OMAS or to recreate the TermAnchor relationship if it has been purged.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchor relationship
    
    Returns:
    
    the created TermAnchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermAnchorRelationship
```
public TermAnchor getTermAnchorRelationship(String userId,
                                            String guid)
                                     throws InvalidParameterException,
                                            MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            UnexpectedResponseException,
                                            UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermAnchorRelationship
```
public TermAnchor updateTermAnchorRelationship(String userId,
                                               TermAnchor termAnchorRelationship)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException
```
    Update a Term Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchor relationship
    
    Returns:
    
    the updated TermAnchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermAnchorRelationship
```
public TermAnchor replaceTermAnchorRelationship(String userId,
                                                TermAnchor termAnchorRelationship)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException
```
    Replace a Term Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchor relationship
    
    Returns:
    
    the updated TermAnchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermAnchorRelationship
```
public TermAnchor deleteTermAnchorRelationship(String userId,
                                               String guid)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnrecognizedGUIDException,
                                               FunctionNotSupportedException,
                                               RelationshipNotDeletedException,
                                               UnexpectedResponseException
```
    Delete a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. * 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 TermAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted TermAnchorRelationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermAnchorRelationship
```
public void purgeTermAnchorRelationship(String userId,
                                        String guid)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        RelationshipNotPurgedException,
                                        UnrecognizedGUIDException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException
```
    Purge a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermAnchorRelationship
```
public TermAnchor restoreTermAnchorRelationship(String userId,
                                                String guid)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException
```
    Restore a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary.
    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 Anchor relationship to delete
    
    Returns:
    
    the restored Term Anchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createCategoryAnchorRelationship
```
public CategoryAnchor createCategoryAnchorRelationship(String userId,
                                                       CategoryAnchor categoryAnchorRelationship)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       UnexpectedResponseException,
                                                       UnrecognizedGUIDException
```
    Create a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. Categories created using the Subject Area OMAS cannot be created without a glossary and there can only be one glossary associated with a Category. This method is to allow glossaries to be associated with Categories that have not been created via the Subject Area OMAS or to recreate the CategoryAnchor relationship if it has been purged.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the created term categorization relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getCategoryAnchorRelationship
```
public CategoryAnchor getCategoryAnchorRelationship(String userId,
                                                    String guid)
                                             throws InvalidParameterException,
                                                    MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    UnexpectedResponseException,
                                                    UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateCategoryAnchorRelationship
```
public CategoryAnchor updateCategoryAnchorRelationship(String userId,
                                                       CategoryAnchor categoryAnchorRelationship)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       UnexpectedResponseException,
                                                       UnrecognizedGUIDException
```
    Update a Category Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the updated category anchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceCategoryAnchorRelationship
```
public CategoryAnchor replaceCategoryAnchorRelationship(String userId,
                                                        CategoryAnchor categoryAnchorRelationship)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        MetadataServerUncontactableException,
                                                        UnexpectedResponseException,
                                                        UnrecognizedGUIDException
```
    Replace a Category Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the replaced category anchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteCategoryAnchorRelationship
```
public CategoryAnchor deleteCategoryAnchorRelationship(String userId,
                                                       String guid)
                                                throws InvalidParameterException,
                                                       MetadataServerUncontactableException,
                                                       UserNotAuthorizedException,
                                                       UnrecognizedGUIDException,
                                                       FunctionNotSupportedException,
                                                       RelationshipNotDeletedException,
                                                       UnexpectedResponseException
```
    Delete a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. * 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 CategoryAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted CategoryAnchorRelationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeCategoryAnchorRelationship
```
public void purgeCategoryAnchorRelationship(String userId,
                                            String guid)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            RelationshipNotPurgedException,
                                            UnrecognizedGUIDException,
                                            MetadataServerUncontactableException,
                                            UnexpectedResponseException
```
    Purge a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreCategoryAnchorRelationship
```
public CategoryAnchor restoreCategoryAnchorRelationship(String userId,
                                                        String guid)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        MetadataServerUncontactableException,
                                                        UnexpectedResponseException,
                                                        UnrecognizedGUIDException
```
    Restore a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary.
    Restore allows the deleted Category Anchor 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 Category Anchor relationship to delete
    
    Returns:
    
    the restored category anchor relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createProjectScopeRelationship
```
public ProjectScope createProjectScopeRelationship(String userId,
                                                   ProjectScope projectScope)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   UnexpectedResponseException,
                                                   UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getProjectScopeRelationship
```
public ProjectScope getProjectScopeRelationship(String userId,
                                                String guid)
                                         throws InvalidParameterException,
                                                MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateProjectScopeRelationship
```
public ProjectScope updateProjectScopeRelationship(String userId,
                                                   ProjectScope projectScopeRelationship)
                                            throws InvalidParameterException,
                                                   MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   UnexpectedResponseException,
                                                   UnrecognizedGUIDException
```
    Update a ProjectScope relationship which is a link between the project content and the project.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    updated ProjectScope relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceProjectScopeRelationship
```
public ProjectScope replaceProjectScopeRelationship(String userId,
                                                    ProjectScope projectScopeRelationship)
                                             throws InvalidParameterException,
                                                    MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    UnexpectedResponseException,
                                                    UnrecognizedGUIDException
```
    Replace a ProjectScope relationship which is a link between the project content and the project.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    replaced ProjectScope relationship
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteProjectScopeRelationship
```
public ProjectScope deleteProjectScopeRelationship(String userId,
                                                   String guid)
                                            throws InvalidParameterException,
                                                   MetadataServerUncontactableException,
                                                   UnrecognizedGUIDException,
                                                   UserNotAuthorizedException,
                                                   FunctionNotSupportedException,
                                                   RelationshipNotDeletedException,
                                                   UnexpectedResponseException
```
    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
    
    Returns:
    
    deleted ProjectScope
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeProjectScopeRelationship
```
public void purgeProjectScopeRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          RelationshipNotPurgedException,
                                          UnrecognizedGUIDException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException
```
    Purge a ProjectScope relationship. A link between the project content and the project. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to delete
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreProjectScopeRelationship
```
public ProjectScope restoreProjectScopeRelationship(String userId,
                                                    String guid)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    MetadataServerUncontactableException,
                                                    UnexpectedResponseException,
                                                    UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getSemanticAssignmentRelationship
```
public SemanticAssignment getSemanticAssignmentRelationship(String userId,
                                                            String guid)
                                                     throws InvalidParameterException,
                                                            MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            UnexpectedResponseException,
                                                            UnrecognizedGUIDException
```
    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:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server

Class RelationshipHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RelationshipHandler

Method Detail

createTermHASARelationship

getTermHASARelationship

updateTermHASARelationship

replaceTermHASARelationship

deleteTermHASARelationship

purgeTermHASARelationship

restoreTermHASARelationship

createRelatedTerm

getRelatedTerm

updateRelatedTerm

replaceRelatedTerm

restoreRelatedTerm

deleteRelatedTerm

purgeRelatedTerm

restoreRelatedTermRelationship

createSynonymRelationship

getSynonymRelationship

updateSynonymRelationship

replaceSynonymRelationship

deleteSynonymRelationship

purgeSynonymRelationship

restoreSynonymRelationship

createAntonymRelationship

getAntonymRelationship

updateAntonymRelationship

replaceAntonymRelationship

deleteAntonymRelationship

purgeAntonymRelationship

restoreAntonymRelationship

createTranslationRelationship

getTranslationRelationship

updateTranslationRelationship

replaceTranslationRelationship

deleteTranslationRelationship

purgeTranslationRelationship

restoreTranslationRelationship

createUsedInContextRelationship

getUsedInContextRelationship

updateUsedInContextRelationship

replaceUsedInContextRelationship

deleteUsedInContextRelationship

purgeUsedInContextRelationship

restoreUsedInContextRelationship

createPreferredTermRelationship

getPreferredTermRelationship

updatePreferredTermRelationship

replacePreferredTermRelationship

deletePreferredTermRelationship

purgePreferredTermRelationship

restorePreferredTermRelationship

createValidValueRelationship

getValidValueRelationship

updateValidValueRelationship

replaceValidValueRelationship

deleteValidValueRelationship

purgeValidValueRelationship

restoreValidValueRelationship

createReplacementTermRelationship

getReplacementTermRelationship

updateReplacementTermRelationship

replaceReplacementTermRelationship

deleteReplacementTermRelationship

purgeReplacementTermRelationship

restoreReplacementTermRelationship

createTermTYPEDBYRelationship

getTermTYPEDBYRelationship

updateTermTYPEDBYRelationship

replaceTermTYPEDBYRelationship

deleteTermTYPEDBYRelationship

purgeTermTYPEDBYRelationship

restoreTypedByRelationship

createIsaRelationship

getIsaRelationship