SubjectAreaRelationshipImpl (Subject Area OMAS Client 1.6 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl
- - org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaRelationshipImpl

All Implemented Interfaces:

SubjectAreaRelationship
```
public class SubjectAreaRelationshipImpl
extends SubjectAreaBaseImpl
implements SubjectAreaRelationship
```
SubjectAreaImpl is the OMAS client library implementation of the SubjectAreaImpl OMAS. This interface provides relationship authoring interface for subject area experts.

Field Summary
- Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl
  omasServerURL, serverName

Constructor Summary

Constructors
Constructor and Description
`SubjectAreaRelationshipImpl(String omasServerURL, String serverName)` Default Constructor used once a connector is created.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Antonym`	`createAntonymRelationship(String userId, Antonym antonym)` Create a antonym relationship.
`CategoryAnchorRelationship`	`createCategoryAnchorRelationship(String userId, CategoryAnchorRelationship termCategorizationRelationship)` Create a Category Anchor Relationship.
`ISARelationship`	`createIsaRelationship(String userId, ISARelationship 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.
`ProjectScopeRelationship`	`createProjectScopeRelationship(String userId, ProjectScopeRelationship 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.
`TermAnchorRelationship`	`createTermAnchorRelationship(String userId, TermAnchorRelationship termCategorizationRelationship)` Create a Term Anchor Relationship.
`TermCategorizationRelationship`	`createTermCategorizationRelationship(String userId, TermCategorizationRelationship termCategorizationRelationship)` Create a Term Categorization Relationship.
`TermHASARelationship`	`createTermHASARelationship(String userId, TermHASARelationship termHASARelationship)` Create a Term HASA Relationship.
`TermISATypeOFRelationship`	`createTermISATypeOFRelationship(String userId, TermISATypeOFRelationship TermISATypeOFRelationship)` Create a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects.
`TermTYPEDBYRelationship`	`createTermTYPEDBYRelationship(String userId, TermTYPEDBYRelationship termTYPEDBYRelationship)` Create a TermTYPEDBYRelationship 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.
`CategoryAnchorRelationship`	`deleteCategoryAnchorRelationship(String userId, String guid)` Delete a Category Anchor Relationship.
`ISARelationship`	`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.
`ProjectScopeRelationship`	`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.
`TermAnchorRelationship`	`deleteTermAnchorRelationship(String userId, String guid)` Delete a Term Anchor Relationship.
`TermCategorizationRelationship`	`deleteTermCategorizationRelationship(String userId, String guid)` Delete a Term Categorization Relationship.
`TermHASARelationship`	`deleteTermHASARelationship(String userId, String guid)` Delete a Term HASA Relationship.
`TermISATypeOFRelationship`	`deleteTermISATypeOFRelationship(String userId, String guid)` Delete a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects.
`TermTYPEDBYRelationship`	`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.
`CategoryAnchorRelationship`	`getCategoryAnchorRelationship(String userId, String guid)` Get a Category Anchor Relationship.
`ISARelationship`	`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.
`ProjectScopeRelationship`	`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.
`TermAnchorRelationship`	`getTermAnchorRelationship(String userId, String guid)` Get a Term Anchor Relationship.
`TermCategorizationRelationship`	`getTermCategorizationRelationship(String userId, String guid)` Get a Term Categorization Relationship.
`TermHASARelationship`	`getTermHASARelationship(String userId, String guid)` Get a Term HASA Relationship.
`TermISATypeOFRelationship`	`getTermISATypeOFRelationship(String userId, String guid)` Get a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects.
`TermTYPEDBYRelationship`	`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 TermISATypeOFRelationship 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 antonymRelationship)` Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchorRelationship`	`replaceCategoryAnchorRelationship(String userId, CategoryAnchorRelationship termCategorizationRelationship)` Replace a Category Anchor Relationship.
`ISARelationship`	`replaceIsaRelationship(String userId, ISARelationship isaRelationship)` Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`replacePreferredTermRelationship(String userId, PreferredTerm preferredTermRelationship)` Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScopeRelationship`	`replaceProjectScopeRelationship(String userId, ProjectScopeRelationship 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 replacementTermRelationship)` Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`replaceSynonymRelationship(String userId, Synonym synonymRelationship)` Replace a Synonym relationship which is a link between glossary terms that have the same meaning
`TermAnchorRelationship`	`replaceTermAnchorRelationship(String userId, TermAnchorRelationship termCategorizationRelationship)` Replace a Term Anchor Relationship.
`TermCategorizationRelationship`	`replaceTermCategorizationRelationship(String userId, TermCategorizationRelationship termCategorizationRelationship)` Replace a Term Categorization Relationship.
`TermHASARelationship`	`replaceTermHASARelationship(String userId, TermHASARelationship termHASARelationship)` Replace a Term HASA Relationship.
`TermISATypeOFRelationship`	`replaceTermISATypeOFRelationship(String userId, TermISATypeOFRelationship isATypeOf)` Replace an isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TermTYPEDBYRelationship`	`replaceTermTYPEDBYRelationship(String userId, TermTYPEDBYRelationship termTYPEDBYRelationship)` Replace an TermTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`replaceTranslationRelationship(String userId, Translation translationRelationship)` 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 usedInContextRelationship)` 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 validValueRelationship)` 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 Restore allows the deleted Antonym relationship to be made active again.
`CategoryAnchorRelationship`	`restoreCategoryAnchorRelationship(String userId, String guid)` Restore a Category Anchor Relationship.
`ISARelationship`	`restoreIsaRelationship(String userId, String guid)` Restore an is a relationship Restore allows the deleted is a relationship to be made active again.
`TermISATypeOFRelationship`	`restoreIsaTypeOfRelationship(String userId, String guid)` Restore an is a type of relationship Restore allows the deleted is a type of relationship to be made active again.
`PreferredTerm`	`restorePreferredTermRelationship(String userId, String guid)` Restore a preferred term relationship Restore allows the deletedpreferred term relationship to be made active again.
`ProjectScopeRelationship`	`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 Restore allows the deleted related term relationship to be made active again.
`RelatedTerm`	`restoreRelatedTermRelationship(String userId, String guid)` Restore a related term relationship Restore allows the deleted related term relationship to be made active again.
`ReplacementTerm`	`restoreReplacementTermRelationship(String userId, String guid)` Restore a replacement term relationship Restore allows the deleted replacement term relationship to be made active again.
`Synonym`	`restoreSynonymRelationship(String userId, String guid)` Restore a Synonym relationship Restore allows the deleted Synonym relationship to be made active again.
`TermAnchorRelationship`	`restoreTermAnchorRelationship(String userId, String guid)` Restore a Term Anchor Relationship.
`TermCategorizationRelationship`	`restoreTermCategorizationRelationship(String userId, String guid)` Restore a Term Categorization Relationship.
`TermHASARelationship`	`restoreTermHASARelationship(String userId, String guid)` Restore a has a relationship Restore allows the deleted has a relationship to be made active again.
`Translation`	`restoreTranslationRelationship(String userId, String guid)` Restore a Translation relationship Restore allows the deleted Translation relationship to be made active again.
`TermTYPEDBYRelationship`	`restoreTypedByRelationship(String userId, String guid)` Restore a typed by relationship Restore allows the deleted typed by relationship to be made active again.
`UsedInContext`	`restoreUsedInContextRelationship(String userId, String guid)` Restore a Used in context relationship Restore allows the deletedUsed in context relationship to be made active again.
`ValidValue`	`restoreValidValueRelationship(String userId, String guid)` Restore a valid value relationship Restore allows the deletedvalid value relationship to be made active again.
`Antonym`	`updateAntonymRelationship(String userId, Antonym antonymRelationship)` Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchorRelationship`	`updateCategoryAnchorRelationship(String userId, CategoryAnchorRelationship termCategorizationRelationship)` Update a Category Anchor Relationship.
`ISARelationship`	`updateIsaRelationship(String userId, ISARelationship isaRelationship)` Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`updatePreferredTermRelationship(String userId, PreferredTerm preferredTermRelationship)` Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScopeRelationship`	`updateProjectScopeRelationship(String userId, ProjectScopeRelationship 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 replacementTermRelationship)` Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`updateSynonymRelationship(String userId, Synonym synonymRelationship)` Update a Synonym relationship which is a link between glossary terms that have the same meaning
`TermCategorizationRelationship`	`updateTermCategorizationRelationship(String userId, TermCategorizationRelationship termCategorizationRelationship)` Update a Term Categorization Relationship.
`TermHASARelationship`	`updateTermHASARelationship(String userId, TermHASARelationship termHASARelationship)` Update a Term HASA Relationship.
`TermISATypeOFRelationship`	`updateTermISATypeOFRelationship(String userId, TermISATypeOFRelationship isATypeOf)` Update a isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TermTYPEDBYRelationship`	`updateTermTYPEDBYRelationship(String userId, TermTYPEDBYRelationship termTYPEDBYRelationship)` Update a TermTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`updateTranslationRelationship(String userId, Translation translationRelationship)` 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 usedInContextRelationship)` 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 validValueRelationship)` 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 org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl
encodeQueryProperty, getRelationships

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SubjectAreaRelationshipImpl
```
public SubjectAreaRelationshipImpl(String omasServerURL,
                                   String serverName)
```
    Default Constructor used once a connector is created.
    
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    omasServerURL - unique id for the connector instance
- Method Detail
  - createTermHASARelationship
```
public TermHASARelationship createTermHASARelationship(String userId,
                                                       TermHASARelationship 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.
    
    Specified by:
    
    createTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the created term HASA relationship Exceptions returned by the server
    
    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 TermHASARelationship 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.
    
    Specified by:
    
    getTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermHASARelationship relationship to get
    
    Returns:
    
    TermHASARelationship Exceptions returned by the server
    
    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 TermHASARelationship updateTermHASARelationship(String userId,
                                                       TermHASARelationship termHASARelationship)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       MetadataServerUncontactableException,
                                                       UnexpectedResponseException,
                                                       UnrecognizedGUIDException
```
    Update a Term HASA Relationship.
    
    Specified by:
    
    updateTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the updated term HASA relationship Exceptions returned by the server
    
    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 TermHASARelationship replaceTermHASARelationship(String userId,
                                                        TermHASARelationship termHASARelationship)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        MetadataServerUncontactableException,
                                                        UnexpectedResponseException,
                                                        UnrecognizedGUIDException
```
    Replace a Term HASA Relationship.
    
    Specified by:
    
    replaceTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the replaced term HASA relationship Exceptions returned by the server
    
    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 TermHASARelationship 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.
    
    Specified by:
    
    deleteTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermHASARelationship relationship to delete
    
    Returns:
    
    Deleted TermHASARelationship Exceptions returned by the server
    
    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,
                                      GUIDNotPurgedException,
                                      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.
    
    Specified by:
    
    purgeTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermHASARelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 TermHASARelationship restoreTermHASARelationship(String userId,
                                                        String guid)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        MetadataServerUncontactableException,
                                                        UnexpectedResponseException,
                                                        UnrecognizedGUIDException
```
    Restore a has a relationship 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.
    
    Specified by:
    
    restoreTermHASARelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the has a relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    relatedTermRelationship - the RelatedTerm relationship
    
    Returns:
    
    the created RelatedTerm relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    RelatedTerm Exceptions returned by the server
    
    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.
    
    Specified by:
    
    updateRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termRelatedTerm - the RelatedTerm relationship
    
    Returns:
    
    the updated term RelatedTerm relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    replaceRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termRelatedTerm - the replacement related term relationship
    
    Returns:
    
    ReplacementTerm replaced related Term relationship Exceptions returned by the server
    
    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 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.
    
    Specified by:
    
    restoreRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the related term relationship to restore
    
    Returns:
    
    response which when successful contains the restored related term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted RelatedTerm Exceptions returned by the server
    
    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,
                             GUIDNotPurgedException,
                             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.
    
    Specified by:
    
    purgeRelatedTerm in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreRelatedTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the related term relationship to delete
    
    Returns:
    
    response which when successful contains the restored related term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonym - the Synonym relationship
    
    Returns:
    
    the created Synonym relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Synonym Exceptions returned by the server
    
    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 synonymRelationship)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    Update a Synonym relationship which is a link between glossary terms that have the same meaning
    
    Specified by:
    
    updateSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonymRelationship - the Synonym relationship
    
    Returns:
    
    updated Synonym relationship Exceptions returned by the server
    
    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 synonymRelationship)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    Replace a Synonym relationship which is a link between glossary terms that have the same meaning
    
    Specified by:
    
    replaceSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonymRelationship - the Synonym relationship
    
    Returns:
    
    replaced synonym relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Synonym Exceptions returned by the server
    
    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,
                                     GUIDNotPurgedException,
                                     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.
    
    Specified by:
    
    purgeSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreSynonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to restore
    
    Returns:
    
    response which when successful contains the restored Synonym relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonym - the Antonym relationship
    
    Returns:
    
    the created antonym relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Antonym Exceptions returned by the server
    
    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 antonymRelationship)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException
```
    Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
    
    Specified by:
    
    updateAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonymRelationship - the Antonym relationship
    
    Returns:
    
    Antonym updated antonym Exceptions returned by the server
    
    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 antonymRelationship)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException
```
    Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
    
    Specified by:
    
    replaceAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonymRelationship - the antonym relationship
    
    Returns:
    
    Antonym replaced antonym Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Antonym Exceptions returned by the server
    
    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,
                                     GUIDNotPurgedException,
                                     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.
    
    Specified by:
    
    purgeAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreAntonymRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete
    
    Returns:
    
    response which when successful contains the restored Synonym relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translation - the Translation relationship
    
    Returns:
    
    the created translation relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Translation Exceptions returned by the server
    
    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 translationRelationship)
                                          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.
    
    Specified by:
    
    updateTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translationRelationship - the Translation relationship
    
    Returns:
    
    Translation updated translation Exceptions returned by the server
    
    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 translationRelationship)
                                           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.
    
    Specified by:
    
    replaceTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translationRelationship - the translation relationship
    
    Returns:
    
    Translation replaced translation Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Translation Exceptions returned by the server
    
    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,
                                         GUIDNotPurgedException,
                                         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.
    
    Specified by:
    
    purgeTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreTranslationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete
    
    Returns:
    
    response which when successful contains the restored Translation relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContext - the UsedInContext relationship
    
    Returns:
    
    the created usedInContext relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    UsedInContext Exceptions returned by the server
    
    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 usedInContextRelationship)
                                              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.
    
    Specified by:
    
    updateUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContextRelationship - the UsedInContext relationship
    
    Returns:
    
    UsedInContext updated usedInContext Exceptions returned by the server
    
    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 usedInContextRelationship)
                                               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.
    
    Specified by:
    
    replaceUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContextRelationship - the usedInContext relationship
    
    Returns:
    
    UsedInContext replaced usedInContext Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted UsedInContext Exceptions returned by the server
    
    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,
                                           GUIDNotPurgedException,
                                           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.
    
    Specified by:
    
    purgeUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the UsedInContext relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreUsedInContextRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Used in context relationship to delete
    
    Returns:
    
    response which when successful contains the restored Used in context relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createPreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTerm - the PreferredTerm relationship
    
    Returns:
    
    the created preferredTerm relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getPreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    PreferredTerm Exceptions returned by the server
    
    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 preferredTermRelationship)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException
```
    Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Specified by:
    
    updatePreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTermRelationship - the PreferredTerm relationship
    
    Returns:
    
    PreferredTerm updated preferredTerm Exceptions returned by the server
    
    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 preferredTermRelationship)
                                               throws InvalidParameterException,
                                                      MetadataServerUncontactableException,
                                                      UserNotAuthorizedException,
                                                      UnexpectedResponseException,
                                                      UnrecognizedGUIDException
```
    Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Specified by:
    
    replacePreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTermRelationship - the preferredTerm relationship
    
    Returns:
    
    PreferredTerm replaced preferredTerm Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deletePreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted PreferredTerm Exceptions returned by the server
    
    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,
                                           GUIDNotPurgedException,
                                           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.
    
    Specified by:
    
    purgePreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the PreferredTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restorePreferredTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the preferred term relationship to delete
    
    Returns:
    
    response which when successful contains the restored preferred term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValue - the ValidValue relationship
    
    Returns:
    
    the created validValue relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ValidValue Exceptions returned by the server
    
    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 validValueRelationship)
                                        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.
    
    Specified by:
    
    updateValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValueRelationship - the ValidValue relationship
    
    Returns:
    
    ValidValue updated validValue Exceptions returned by the server
    
    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 validValueRelationship)
                                         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.
    
    Specified by:
    
    replaceValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValueRelationship - the validValue relationship
    
    Returns:
    
    ValidValue replaced validValue Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ValidValue Exceptions returned by the server
    
    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,
                                        GUIDNotPurgedException,
                                        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.
    
    Specified by:
    
    purgeValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ValidValue relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreValidValueRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the valid value relationship to delete
    
    Returns:
    
    response which when successful contains the restored valid value relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    createReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTerm - the ReplacementTerm relationship
    
    Returns:
    
    the created replacementTerm relationship Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ReplacementTerm Exceptions returned by the server
    
    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 replacementTermRelationship)
                                                  throws InvalidParameterException,
                                                         MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         UnexpectedResponseException,
                                                         UnrecognizedGUIDException
```
    Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Specified by:
    
    updateReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTermRelationship - the ReplacementTerm relationship
    
    Returns:
    
    ReplacementTerm updated replacementTerm Exceptions returned by the server
    
    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 replacementTermRelationship)
                                                   throws InvalidParameterException,
                                                          MetadataServerUncontactableException,
                                                          UserNotAuthorizedException,
                                                          UnexpectedResponseException,
                                                          UnrecognizedGUIDException
```
    Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Specified by:
    
    replaceReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTermRelationship - the replacementTerm relationship
    
    Returns:
    
    ReplacementTerm replaced replacementTerm Exceptions returned by the server
    
    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.
    
    Specified by:
    
    deleteReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ReplacementTerm Exceptions returned by the server
    
    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,
                                             GUIDNotPurgedException,
                                             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.
    
    Specified by:
    
    purgeReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ReplacementTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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.
    
    Specified by:
    
    restoreReplacementTermRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the replacement term relationship to delete
    
    Returns:
    
    response which when successful contains the restored replacement term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 TermTYPEDBYRelationship createTermTYPEDBYRelationship(String userId,
                                                             TermTYPEDBYRelationship termTYPEDBYRelationship)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             MetadataServerUncontactableException,
                                                             UnexpectedResponseException,
                                                             UnrecognizedGUIDException
```
    Create a TermTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    
    Specified by:
    
    createTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the TermTYPEDBYRelationship relationship
    
    Returns:
    
    the created termTYPEDBYRelationship relationship Exceptions returned by the server
    
    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 TermTYPEDBYRelationship 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.
    
    Specified by:
    
    getTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termTYPEDBY relationship to get
    
    Returns:
    
    TermTYPEDBYRelationship Exceptions returned by the server
    
    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 TermTYPEDBYRelationship updateTermTYPEDBYRelationship(String userId,
                                                             TermTYPEDBYRelationship termTYPEDBYRelationship)
                                                      throws InvalidParameterException,
                                                             MetadataServerUncontactableException,
                                                             UserNotAuthorizedException,
                                                             UnexpectedResponseException,
                                                             UnrecognizedGUIDException
```
    Update a TermTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    
    Specified by:
    
    updateTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the TermTYPEDBYRelationship relationship
    
    Returns:
    
    TermTYPEDBYRelationship updated termTYPEDBYRelationship Exceptions returned by the server
    
    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 TermTYPEDBYRelationship replaceTermTYPEDBYRelationship(String userId,
                                                              TermTYPEDBYRelationship termTYPEDBYRelationship)
                                                       throws InvalidParameterException,
                                                              MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              UnexpectedResponseException,
                                                              UnrecognizedGUIDException
```
    Replace an TermTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    
    Specified by:
    
    replaceTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the termTYPEDBYRelationship relationship
    
    Returns:
    
    TermTYPEDBYRelationship replaced termTYPEDBYRelationship Exceptions returned by the server
    
    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 TermTYPEDBYRelationship 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.
    
    Specified by:
    
    deleteTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    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:
    
    deleted TermTYPEDBYRelationship Exceptions returned by the server
    
    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,
                                         GUIDNotPurgedException,
                                         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.
    
    Specified by:
    
    purgeTermTYPEDBYRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermTYPEDBYRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 TermTYPEDBYRelationship 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.
    
    Specified by:
    
    restoreTypedByRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the typed by relationship to delete
    
    Returns:
    
    response which when successful contains the restored typed by relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 ISARelationship createIsaRelationship(String userId,
                                             ISARelationship 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.
    
    Specified by:
    
    createIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isa - the Isa relationship
    
    Returns:
    
    the created isa relationship Exceptions returned by the server
    
    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 ISARelationship 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.
    
    Specified by:
    
    getIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the isa relationship to get
    
    Returns:
    
    Isa Exceptions returned by the server
    
    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 ISARelationship updateIsaRelationship(String userId,
                                             ISARelationship isaRelationship)
                                      throws InvalidParameterException,
                                             MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException
```
    Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Specified by:
    
    updateIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isaRelationship - the Isa relationship
    
    Returns:
    
    Isa updated isa Exceptions returned by the server
    
    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 ISARelationship replaceIsaRelationship(String userId,
                                              ISARelationship isaRelationship)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException
```
    Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Specified by:
    
    replaceIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isaRelationship - the isa relationship
    
    Returns:
    
    Isa replaced isa Exceptions returned by the server
    
    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 ISARelationship 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.
    
    Specified by:
    
    deleteIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the isa relationship to delete
    
    Returns:
    
    deleted Isa Exceptions returned by the server
    
    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,
                                 GUIDNotPurgedException,
                                 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.
    
    Specified by:
    
    purgeIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Isa relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 ISARelationship 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.
    
    Specified by:
    
    restoreIsaRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the is a relationship to delete
    
    Returns:
    
    response which when successful contains the restored is a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 TermISATypeOFRelationship createTermISATypeOFRelationship(String userId,
                                                                 TermISATypeOFRelationship TermISATypeOFRelationship)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 MetadataServerUncontactableException,
                                                                 UnexpectedResponseException,
                                                                 UnrecognizedGUIDException
```
    Create a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects.
    
    Specified by:
    
    createTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    TermISATypeOFRelationship - the TermISATypeOFRelationship relationship
    
    Returns:
    
    the created TermISATypeOFRelationship relationship Exceptions returned by the server
    
    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 TermISATypeOFRelationship getTermISATypeOFRelationship(String userId,
                                                              String guid)
                                                       throws InvalidParameterException,
                                                              MetadataServerUncontactableException,
                                                              UserNotAuthorizedException,
                                                              UnexpectedResponseException,
                                                              UnrecognizedGUIDException
```
    Get a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects.
    
    Specified by:
    
    getTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermISATypeOFRelationship relationship to get
    
    Returns:
    
    TermISATypeOFRelationship Exceptions returned by the server
    
    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 TermISATypeOFRelationship updateTermISATypeOFRelationship(String userId,
                                                                 TermISATypeOFRelationship isATypeOf)
                                                          throws InvalidParameterException,
                                                                 MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 UnexpectedResponseException,
                                                                 UnrecognizedGUIDException
```
    Update a isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Specified by:
    
    updateTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isATypeOf - the isATypeOf relationship
    
    Returns:
    
    isATypeOf updated isATypeOf Exceptions returned by the server
    
    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 TermISATypeOFRelationship replaceTermISATypeOFRelationship(String userId,
                                                                  TermISATypeOFRelationship isATypeOf)
                                                           throws InvalidParameterException,
                                                                  MetadataServerUncontactableException,
                                                                  UserNotAuthorizedException,
                                                                  UnexpectedResponseException,
                                                                  UnrecognizedGUIDException
```
    Replace an isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Specified by:
    
    replaceTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isATypeOf - the isATypeOf relationship
    
    Returns:
    
    isATypeOf replaced isATypeOf Exceptions returned by the server
    
    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 TermISATypeOFRelationship deleteTermISATypeOFRelationship(String userId,
                                                                 String guid)
                                                          throws InvalidParameterException,
                                                                 MetadataServerUncontactableException,
                                                                 UserNotAuthorizedException,
                                                                 UnrecognizedGUIDException,
                                                                 FunctionNotSupportedException,
                                                                 RelationshipNotDeletedException,
                                                                 UnexpectedResponseException
```
    Delete a TermISATypeOFRelationship 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.
    
    Specified by:
    
    deleteTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    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:
    
    deleted TermISATypeOFRelationship Exceptions returned by the server
    
    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,
                                           GUIDNotPurgedException,
                                           UnrecognizedGUIDException,
                                           MetadataServerUncontactableException,
                                           UnexpectedResponseException
```
    Purge a TermISATypeOFRelationship relationship, which is defines an inheritance relationship between two spine objects. A purge means that the relationship will not exist after the operation.
    
    Specified by:
    
    purgeTermISATypeOFRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermISATypeOFRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 TermISATypeOFRelationship 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.
    
    Specified by:
    
    restoreIsaTypeOfRelationship in interface SubjectAreaRelationship
    
    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:
    
    response which when successful contains the restored is a type of relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 TermCategorizationRelationship createTermCategorizationRelationship(String userId,
                                                                           TermCategorizationRelationship 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.
    
    Specified by:
    
    createTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the created term categorization relationship Exceptions returned by the server
    
    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 TermCategorizationRelationship 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.
    
    Specified by:
    
    getTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to get
    
    Returns:
    
    TermCategorizationRelationship Exceptions returned by the server
    
    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 TermCategorizationRelationship updateTermCategorizationRelationship(String userId,
                                                                           TermCategorizationRelationship 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.
    
    Specified by:
    
    updateTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the updated term categorization relationship Exceptions returned by the server
    
    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 TermCategorizationRelationship replaceTermCategorizationRelationship(String userId,
                                                                            TermCategorizationRelationship termCategorizationRelationship)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            MetadataServerUncontactableException,
                                                                            UnexpectedResponseException,
                                                                            UnrecognizedGUIDException
```
    Replace a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    
    Specified by:
    
    replaceTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the replaced term categorization relationship Exceptions returned by the server
    
    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 TermCategorizationRelationship 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.
    
    Specified by:
    
    deleteTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete
    
    Returns:
    
    Deleted TermCategorizationRelationship Exceptions returned by the server
    
    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,
                                                GUIDNotPurgedException,
                                                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.
    
    Specified by:
    
    purgeTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 TermCategorizationRelationship 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 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.
    
    Specified by:
    
    restoreTermCategorizationRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the has a relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 TermAnchorRelationship createTermAnchorRelationship(String userId,
                                                           TermAnchorRelationship termCategorizationRelationship)
                                                    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 Subject Area OMAS 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 Subject Area OMAS.
    
    Specified by:
    
    createTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term anchor relationship
    
    Returns:
    
    the created term anchor relationship Exceptions returned by the server
    
    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 TermAnchorRelationship 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.
    
    Specified by:
    
    getTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to get
    
    Returns:
    
    TermAnchorRelationship Exceptions returned by the server
    
    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
  - replaceTermAnchorRelationship
```
public TermAnchorRelationship replaceTermAnchorRelationship(String userId,
                                                            TermAnchorRelationship termCategorizationRelationship)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            MetadataServerUncontactableException,
                                                            UnexpectedResponseException,
                                                            UnrecognizedGUIDException
```
    Replace a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary.
    
    Specified by:
    
    replaceTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term anchor relationship
    
    Returns:
    
    the replaced term anchor relationship Exceptions returned by the server
    
    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 TermAnchorRelationship 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.
    
    Specified by:
    
    deleteTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted TermAnchorRelationship Exceptions returned by the server
    
    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,
                                        GUIDNotPurgedException,
                                        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.
    
    Specified by:
    
    purgeTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 TermAnchorRelationship 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 Glossaries. 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.
    
    Specified by:
    
    restoreTermAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Term Anchor relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 CategoryAnchorRelationship createCategoryAnchorRelationship(String userId,
                                                                   CategoryAnchorRelationship termCategorizationRelationship)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   UnexpectedResponseException,
                                                                   UnrecognizedGUIDException
```
    Create a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categories 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.
    
    Specified by:
    
    createCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the category anchor relationship
    
    Returns:
    
    the created category anchor relationship Exceptions returned by the server
    
    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 CategoryAnchorRelationship 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 categories to be owned by a glossary.
    
    Specified by:
    
    getCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to get
    
    Returns:
    
    CategoryAnchorRelationship Exceptions returned by the server
    
    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 CategoryAnchorRelationship updateCategoryAnchorRelationship(String userId,
                                                                   CategoryAnchorRelationship termCategorizationRelationship)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   MetadataServerUncontactableException,
                                                                   UnexpectedResponseException,
                                                                   UnrecognizedGUIDException
```
    Update a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categories to be owned by a glossary.
    
    Specified by:
    
    updateCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the Category Anchor relationship
    
    Returns:
    
    the updated Category Anchor relationship Exceptions returned by the server
    
    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 CategoryAnchorRelationship replaceCategoryAnchorRelationship(String userId,
                                                                    CategoryAnchorRelationship termCategorizationRelationship)
                                                             throws InvalidParameterException,
                                                                    UserNotAuthorizedException,
                                                                    MetadataServerUncontactableException,
                                                                    UnexpectedResponseException,
                                                                    UnrecognizedGUIDException
```
    Replace a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categories to be owned by a glossary.
    
    Specified by:
    
    replaceCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the Category Anchor relationship
    
    Returns:
    
    the replaced Category Anchor relationship Exceptions returned by the server
    
    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 CategoryAnchorRelationship 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 categories 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.
    
    Specified by:
    
    deleteCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted CategoryAnchorRelationship Exceptions returned by the server
    
    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,
                                            GUIDNotPurgedException,
                                            UnrecognizedGUIDException,
                                            MetadataServerUncontactableException,
                                            UnexpectedResponseException
```
    Purge a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categories to be owned by a glossary. A purge means that the relationship will not exist after the operation.
    
    Specified by:
    
    purgeCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 CategoryAnchorRelationship 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 categories to be owned by a glossary. 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.
    
    Specified by:
    
    restoreCategoryAnchorRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the has a relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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 ProjectScopeRelationship createProjectScopeRelationship(String userId,
                                                               ProjectScopeRelationship projectScope)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               MetadataServerUncontactableException,
                                                               UnexpectedResponseException,
                                                               UnrecognizedGUIDException
```
    Create a ProjectScope relationship. A link between the project content and the project.
    
    Specified by:
    
    createProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScope - the ProjectScope relationship
    
    Returns:
    
    the created ProjectScope relationship Exceptions returned by the server
    
    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 ProjectScopeRelationship getProjectScopeRelationship(String userId,
                                                            String guid)
                                                     throws InvalidParameterException,
                                                            MetadataServerUncontactableException,
                                                            UserNotAuthorizedException,
                                                            UnexpectedResponseException,
                                                            UnrecognizedGUIDException
```
    Get a ProjectScope relationship. A link between the project content and the project.
    
    Specified by:
    
    getProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ProjectScope Exceptions returned by the server
    
    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 ProjectScopeRelationship updateProjectScopeRelationship(String userId,
                                                               ProjectScopeRelationship projectScopeRelationship)
                                                        throws InvalidParameterException,
                                                               MetadataServerUncontactableException,
                                                               UserNotAuthorizedException,
                                                               UnexpectedResponseException,
                                                               UnrecognizedGUIDException
```
    Update a ProjectScope relationship which is a link between the project content and the project.
    
    Specified by:
    
    updateProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    updated ProjectScope relationship Exceptions returned by the server
    
    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 ProjectScopeRelationship replaceProjectScopeRelationship(String userId,
                                                                ProjectScopeRelationship projectScopeRelationship)
                                                         throws InvalidParameterException,
                                                                MetadataServerUncontactableException,
                                                                UserNotAuthorizedException,
                                                                UnexpectedResponseException,
                                                                UnrecognizedGUIDException
```
    Replace a ProjectScope relationship which is a link between the project content and the project.
    
    Specified by:
    
    replaceProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    replaced ProjectScope relationship Exceptions returned by the server
    
    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 ProjectScopeRelationship 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.
    
    Specified by:
    
    deleteProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ProjectScope Exceptions returned by the server
    
    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,
                                          GUIDNotPurgedException,
                                          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.
    
    Specified by:
    
    purgeProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    GUIDNotPurgedException - 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 ProjectScopeRelationship 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.
    
    Specified by:
    
    restoreProjectScopeRelationship in interface SubjectAreaRelationship
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to restore
    
    Returns:
    
    response which when successful contains the restored ProjectScope relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    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.
    
    Specified by:
    
    getSemanticAssignmentRelationship in interface SubjectAreaRelationship
    
    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 Exceptions returned by the server
    
    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 SubjectAreaRelationshipImpl

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

Methods inherited from class java.lang.Object

Constructor Detail

SubjectAreaRelationshipImpl

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