java.lang.Object
- org.odpi.openmetadata.accessservices.assetmanager.client.ExchangeClientBase
- - org.odpi.openmetadata.accessservices.assetmanager.client.GlossaryExchangeClient

All Implemented Interfaces:

GlossaryExchangeInterface
```
public class GlossaryExchangeClient
extends ExchangeClientBase
implements GlossaryExchangeInterface
```
GlossaryExchangeClient is the client for managing resources from a glossary.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`attachExternalCategoryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryCategoryGUID, ExternalGlossaryElementLinkProperties linkProperties)`	Create a link to an external glossary category resource.
`void`	`attachExternalLinkToGlossary(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryGUID)`	Connect a glossary to a reference to an external glossary resource.
`void`	`attachExternalTermLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryTermGUID, ExternalGlossaryElementLinkProperties linkProperties)`	Create a link to an external glossary term resource.
`void`	`clearCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID)`	Remove a parent-child relationship between two categories.
`void`	`clearGlossaryAsCanonical(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the canonical designation from the glossary.
`void`	`clearGlossaryAsTaxonomy(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the taxonomy designation from the glossary.
`void`	`clearTermAsAbstractConcept(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the abstract concept designation from the glossary term.
`void`	`clearTermAsActivity(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the activity designation from the glossary term.
`void`	`clearTermAsContext(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the context definition designation from the glossary term.
`void`	`clearTermAsDataValue(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the data value designation from the glossary term.
`void`	`clearTermAsObjectIdentifier(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the object identifier designation from the glossary term.
`void`	`clearTermAsSpineAttribute(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the spine attribute designation from the glossary term.
`void`	`clearTermAsSpineObject(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the spine object designation from the glossary term.
`void`	`clearTermCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryTermGUID)`	Unlink a term from a category.
`void`	`clearTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID)`	Remove the relationship between two terms.
`String`	`createControlledGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryTermExternalIdentifier, String glossaryTermExternalIdentifierName, String glossaryTermExternalIdentifierUsage, String glossaryTermExternalIdentifierSource, KeyPattern glossaryTermExternalIdentifierKeyPattern, Map<String,String> mappingProperties, GlossaryTermProperties glossaryTermProperties, GlossaryTermStatus initialStatus)`	Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
`String`	`createExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, ExternalGlossaryLinkProperties linkProperties)`	Create a link to an external glossary resource.
`String`	`createGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryExternalIdentifier, String glossaryExternalIdentifierName, String glossaryExternalIdentifierUsage, String glossaryExternalIdentifierSource, KeyPattern glossaryExternalIdentifierKeyPattern, Map<String,String> mappingProperties, GlossaryProperties glossaryProperties)`	Create a new metadata element to represent the root of a glossary.
`String`	`createGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryCategoryExternalIdentifier, String glossaryCategoryExternalIdentifierName, String glossaryCategoryExternalIdentifierUsage, String glossaryCategoryExternalIdentifierSource, KeyPattern glossaryCategoryExternalIdentifierKeyPattern, Map<String,String> mappingProperties, GlossaryCategoryProperties glossaryCategoryProperties)`	Create a new metadata element to represent a glossary category.
`String`	`createGlossaryCategoryFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, String glossaryCategoryExternalIdentifier, String glossaryCategoryExternalIdentifierName, String glossaryCategoryExternalIdentifierUsage, String glossaryCategoryExternalIdentifierSource, KeyPattern glossaryCategoryExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary category using an existing metadata element as a template.
`String`	`createGlossaryFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, String glossaryExternalIdentifier, String glossaryExternalIdentifierName, String glossaryExternalIdentifierUsage, String glossaryExternalIdentifierSource, KeyPattern glossaryExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary using an existing metadata element as a template.
`String`	`createGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryTermExternalIdentifier, String glossaryTermExternalIdentifierName, String glossaryTermExternalIdentifierUsage, String glossaryTermExternalIdentifierSource, KeyPattern glossaryTermExternalIdentifierKeyPattern, Map<String,String> mappingProperties, GlossaryTermProperties glossaryTermProperties)`	Create a new metadata element to represent a glossary term.
`String`	`createGlossaryTermFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, String glossaryTermExternalIdentifier, String glossaryTermExternalIdentifierName, String glossaryTermExternalIdentifierUsage, String glossaryTermExternalIdentifierSource, KeyPattern glossaryTermExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary term using an existing metadata element as a template.
`void`	`detachExternalCategoryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryCategoryGUID)`	Remove the link to an external glossary category resource.
`void`	`detachExternalLinkFromGlossary(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryGUID)`	Disconnect a glossary from a reference to an external glossary resource.
`void`	`detachExternalTermLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryTermGUID)`	Remove the link to an external glossary term resource.
`List<GlossaryElement>`	`findGlossaries(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)`	Retrieve the list of glossary metadata elements that contain the search string.
`List<GlossaryCategoryElement>`	`findGlossaryCategories(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)`	Retrieve the list of glossary category metadata elements that contain the search string.
`List<GlossaryTermElement>`	`findGlossaryTerms(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)`	Retrieve the list of glossary term metadata elements that contain the search string.
`List<GlossaryCategoryElement>`	`getCategoriesForGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, int startFrom, int pageSize)`	Return the list of categories associated with a glossary.
`List<ExternalGlossaryLinkElement>`	`getExternalLinksForGlossary(String userId, String glossaryGUID, int startFrom, int pageSize)`	Retrieve the list of links to external glossary resources attached to a glossary.
`List<GlossaryElement>`	`getGlossariesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)`	Retrieve the list of glossary metadata elements with a matching qualified or display name.
`List<GlossaryElement>`	`getGlossariesForAssetManager(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize)`	Retrieve the list of glossaries created on behalf of the named asset manager.
`List<GlossaryElement>`	`getGlossariesForExternalLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, int startFrom, int pageSize)`	Return the glossaries connected to an external glossary source.
`GlossaryElement`	`getGlossaryByGUID(String userId, String assetManagerGUID, String assetManagerName, String guid)`	Retrieve the glossary metadata element with the supplied unique identifier.
`List<GlossaryCategoryElement>`	`getGlossaryCategoriesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)`	Retrieve the list of glossary category metadata elements with a matching qualified or display name.
`GlossaryCategoryElement`	`getGlossaryCategoryByGUID(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryCategoryElement`	`getGlossaryCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`List<GlossaryCategoryElement>`	`getGlossarySubCategories(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, int startFrom, int pageSize)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryTermElement`	`getGlossaryTermByGUID(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID)`	Retrieve the glossary term metadata element with the supplied unique identifier.
`List<GlossaryTermElement>`	`getGlossaryTermsByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)`	Retrieve the list of glossary term metadata elements with a matching qualified or display name.
`List<GlossaryTermElement>`	`getTermsForGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, int startFrom, int pageSize)`	Retrieve the list of glossary terms associated with a glossary.
`List<GlossaryTermElement>`	`getTermsForGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, int startFrom, int pageSize)`	Retrieve the list of glossary terms associated with a glossary category.
`void`	`removeExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID)`	Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
`void`	`removeGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the metadata element representing a glossary.
`void`	`removeGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier)`	Remove the metadata element representing a glossary category.
`void`	`removeGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Remove the metadata element representing a glossary term.
`void`	`setGlossaryAsCanonical(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, String scope)`	Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.
`void`	`setGlossaryAsTaxonomy(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, String organizingPrinciple)`	Classify the glossary to indicate that it can be used as a taxonomy.
`void`	`setTermAsAbstractConcept(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Classify the glossary term to indicate that it describes an abstract concept.
`void`	`setTermAsActivity(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermActivityType activityType)`	Classify the glossary term to indicate that it describes a data value.
`void`	`setTermAsContext(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermContextDefinition contextDefinition)`	Classify the glossary term to indicate that it describes a context.
`void`	`setTermAsDataValue(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Classify the glossary term to indicate that it describes a data value.
`void`	`setTermAsObjectIdentifier(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Classify the glossary term to indicate that it describes an object identifier.
`void`	`setTermAsSpineAttribute(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Classify the glossary term to indicate that it describes a spine attribute.
`void`	`setTermAsSpineObject(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier)`	Classify the glossary term to indicate that it describes a spine object.
`void`	`setupCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID)`	Create a parent-child relationship between two categories.
`void`	`setupTermCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryTermGUID, GlossaryTermCategorization categorizationProperties)`	Link a term to a category.
`void`	`setupTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties)`	Link two terms together using a specialist relationship.
`void`	`updateExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, ExternalGlossaryLinkProperties linkProperties)`	Update the properties of a reference to an external glossary resource.
`void`	`updateGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, GlossaryProperties glossaryProperties)`	Update the metadata element representing a glossary.
`void`	`updateGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier, GlossaryCategoryProperties glossaryCategoryProperties)`	Update the metadata element representing a glossary category.
`void`	`updateGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermProperties glossaryTermProperties)`	Update the metadata element representing a glossary term.
`void`	`updateGlossaryTermStatus(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermStatus glossaryTermStatus)`	Update the status of the metadata element representing a glossary term.
`void`	`updateTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties)`	Update the relationship properties for the two terms.

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

Constructor Detail
- GlossaryExchangeClient
```
public GlossaryExchangeClient(String serverName,
                              String serverPlatformURLRoot,
                              AuditLog auditLog)
                       throws InvalidParameterException
```
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST servers
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- GlossaryExchangeClient
```
public GlossaryExchangeClient(String serverName,
                              String serverPlatformURLRoot)
                       throws InvalidParameterException
```
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST servers
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- GlossaryExchangeClient
```
public GlossaryExchangeClient(String serverName,
                              String serverPlatformURLRoot,
                              String userId,
                              String password,
                              AuditLog auditLog)
                       throws InvalidParameterException
```
  Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST servers
  
  userId - caller's userId embedded in all HTTP requests
  
  password - caller's userId embedded in all HTTP requests
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- GlossaryExchangeClient
```
public GlossaryExchangeClient(String serverName,
                              String serverPlatformURLRoot,
                              AssetManagerRESTClient restClient,
                              int maxPageSize,
                              AuditLog auditLog)
                       throws InvalidParameterException
```
  Create a new client that is going to be used in an OMAG Server.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST servers
  
  restClient - client that issues the REST API calls
  
  maxPageSize - maximum number of results supported by this server
  
  auditLog - logging destination
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.
- GlossaryExchangeClient
```
public GlossaryExchangeClient(String serverName,
                              String serverPlatformURLRoot,
                              String userId,
                              String password)
                       throws InvalidParameterException
```
  Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
  
  Parameters:
  
  serverName - name of the server to connect to
  
  serverPlatformURLRoot - the network address of the server running the OMAS REST servers
  
  userId - caller's userId embedded in all HTTP requests
  
  password - caller's userId embedded in all HTTP requests
  
  Throws:
  
  InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createGlossary
```
public String createGlossary(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String glossaryExternalIdentifier,
                             String glossaryExternalIdentifierName,
                             String glossaryExternalIdentifierUsage,
                             String glossaryExternalIdentifierSource,
                             KeyPattern glossaryExternalIdentifierKeyPattern,
                             Map<String,String> mappingProperties,
                             GlossaryProperties glossaryProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
Create a new metadata element to represent the root of a glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.

Specified by:

createGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

glossaryExternalIdentifierName - name of property for the external identifier in the external asset manager

glossaryExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

glossaryExternalIdentifierSource - component that issuing this request.

glossaryExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

glossaryProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGlossaryFromTemplate
```
public String createGlossaryFromTemplate(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String templateGUID,
                                         String glossaryExternalIdentifier,
                                         String glossaryExternalIdentifierName,
                                         String glossaryExternalIdentifierUsage,
                                         String glossaryExternalIdentifierSource,
                                         KeyPattern glossaryExternalIdentifierKeyPattern,
                                         Map<String,String> mappingProperties,
                                         TemplateProperties templateProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.

Specified by:

createGlossaryFromTemplate in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

glossaryExternalIdentifierName - name of property for the external identifier in the external asset manager

glossaryExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

glossaryExternalIdentifierSource - component that issuing this request.

glossaryExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGlossary
```
public void updateGlossary(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String glossaryGUID,
                           String glossaryExternalIdentifier,
                           GlossaryProperties glossaryProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
Update the metadata element representing a glossary.

Specified by:

updateGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryGUID - unique identifier of the metadata element to update

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

glossaryProperties - new properties for this element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setGlossaryAsTaxonomy
```
public void setGlossaryAsTaxonomy(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String glossaryGUID,
                                  String glossaryExternalIdentifier,
                                  String organizingPrinciple)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
Classify the glossary to indicate that it can be used as a taxonomy. This means each term is attached to one, and only one category and the categories are organized as a hierarchy with a single root category. Taxonomies are used as a way of organizing assets and other related metadata. The terms in the taxonomy are linked to the assets etc and as such they are logically categorized by the linked category.

Specified by:

setGlossaryAsTaxonomy in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

organizingPrinciple - description of how the glossary is organized

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearGlossaryAsTaxonomy

public void clearGlossaryAsTaxonomy(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String glossaryGUID,
                                    String glossaryExternalIdentifier)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Remove the taxonomy designation from the glossary.

Specified by:: clearGlossaryAsTaxonomy in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the metadata element to remove; glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

setGlossaryAsCanonical
```
public void setGlossaryAsCanonical(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String glossaryGUID,
                                   String glossaryExternalIdentifier,
                                   String scope)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name. This means there is only one definition for each term. Typically the terms are also of a similar level of granularity and are limited to a specific scope of use. Canonical vocabularies are used to semantically classify assets in an unambiguous way.

Specified by:

setGlossaryAsCanonical in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

scope - description of the situations where this glossary is relevant.

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearGlossaryAsCanonical

public void clearGlossaryAsCanonical(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String glossaryGUID,
                                     String glossaryExternalIdentifier)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the canonical designation from the glossary.

Specified by:: clearGlossaryAsCanonical in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the metadata element to remove; glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

removeGlossary
```
public void removeGlossary(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String glossaryGUID,
                           String glossaryExternalIdentifier)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.

Specified by:

removeGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGlossaries

public List<GlossaryElement> findGlossaries(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String searchString,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:: findGlossaries in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossariesByName

public List<GlossaryElement> getGlossariesByName(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String name,
                                                 int startFrom,
                                                 int pageSize)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:: getGlossariesByName in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossariesForAssetManager

public List<GlossaryElement> getGlossariesForAssetManager(String userId,
                                                          String assetManagerGUID,
                                                          String assetManagerName,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the list of glossaries created on behalf of the named asset manager.

Specified by:: getGlossariesForAssetManager in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryByGUID
```
public GlossaryElement getGlossaryByGUID(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
Retrieve the glossary metadata element with the supplied unique identifier.

Specified by:

getGlossaryByGUID in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

guid - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createGlossaryCategory

public String createGlossaryCategory(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String glossaryGUID,
                                     String glossaryCategoryExternalIdentifier,
                                     String glossaryCategoryExternalIdentifierName,
                                     String glossaryCategoryExternalIdentifierUsage,
                                     String glossaryCategoryExternalIdentifierSource,
                                     KeyPattern glossaryCategoryExternalIdentifierKeyPattern,
                                     Map<String,String> mappingProperties,
                                     GlossaryCategoryProperties glossaryCategoryProperties)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Create a new metadata element to represent a glossary category.

Specified by:: createGlossaryCategory in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the glossary where the category is located; glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager; glossaryCategoryExternalIdentifierName - name of property for the external identifier in the external asset manager; glossaryCategoryExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager; glossaryCategoryExternalIdentifierSource - component that issuing this request.; glossaryCategoryExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY); mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata; glossaryCategoryProperties - properties about the glossary category to store
Returns:: unique identifier of the new glossary category
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

createGlossaryCategoryFromTemplate

public String createGlossaryCategoryFromTemplate(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String templateGUID,
                                                 String glossaryCategoryExternalIdentifier,
                                                 String glossaryCategoryExternalIdentifierName,
                                                 String glossaryCategoryExternalIdentifierUsage,
                                                 String glossaryCategoryExternalIdentifierSource,
                                                 KeyPattern glossaryCategoryExternalIdentifierKeyPattern,
                                                 Map<String,String> mappingProperties,
                                                 TemplateProperties templateProperties)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Create a new metadata element to represent a glossary category using an existing metadata element as a template.

Specified by:: createGlossaryCategoryFromTemplate in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; templateGUID - unique identifier of the metadata element to copy; glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager; glossaryCategoryExternalIdentifierName - name of property for the external identifier in the external asset manager; glossaryCategoryExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager; glossaryCategoryExternalIdentifierSource - component that issuing this request.; glossaryCategoryExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY); mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata; templateProperties - properties that override the template
Returns:: unique identifier of the new glossary category
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

updateGlossaryCategory

public void updateGlossaryCategory(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String glossaryCategoryGUID,
                                   String glossaryCategoryExternalIdentifier,
                                   GlossaryCategoryProperties glossaryCategoryProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Update the metadata element representing a glossary category.

Specified by:: updateGlossaryCategory in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the metadata element to update; glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager; glossaryCategoryProperties - new properties for the metadata element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

setupCategoryParent
```
public void setupCategoryParent(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String glossaryParentCategoryGUID,
                                String glossaryChildCategoryGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
Create a parent-child relationship between two categories.

Specified by:

setupCategoryParent in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category

glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearCategoryParent
```
public void clearCategoryParent(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String glossaryParentCategoryGUID,
                                String glossaryChildCategoryGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
Remove a parent-child relationship between two categories.

Specified by:

clearCategoryParent in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category

glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGlossaryCategory
```
public void removeGlossaryCategory(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String glossaryCategoryGUID,
                                   String glossaryCategoryExternalIdentifier)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
Remove the metadata element representing a glossary category.

Specified by:

removeGlossaryCategory in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryCategoryGUID - unique identifier of the metadata element to remove

glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGlossaryCategories

public List<GlossaryCategoryElement> findGlossaryCategories(String userId,
                                                            String assetManagerGUID,
                                                            String assetManagerName,
                                                            String searchString,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:: findGlossaryCategories in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getCategoriesForGlossary

public List<GlossaryCategoryElement> getCategoriesForGlossary(String userId,
                                                              String assetManagerGUID,
                                                              String assetManagerName,
                                                              String glossaryGUID,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Return the list of categories associated with a glossary.

Specified by:: getCategoriesForGlossary in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the glossary to query; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of metadata elements describing the categories associated with the requested glossary
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryCategoriesByName

public List<GlossaryCategoryElement> getGlossaryCategoriesByName(String userId,
                                                                 String assetManagerGUID,
                                                                 String assetManagerName,
                                                                 String name,
                                                                 int startFrom,
                                                                 int pageSize)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:: getGlossaryCategoriesByName in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryCategoryByGUID

public GlossaryCategoryElement getGlossaryCategoryByGUID(String userId,
                                                         String assetManagerGUID,
                                                         String assetManagerName,
                                                         String glossaryCategoryGUID)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the glossary category metadata element with the supplied unique identifier.

Specified by:: getGlossaryCategoryByGUID in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element
Returns:: requested metadata element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryCategoryParent

public GlossaryCategoryElement getGlossaryCategoryParent(String userId,
                                                         String assetManagerGUID,
                                                         String assetManagerName,
                                                         String glossaryCategoryGUID)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the glossary category metadata element with the supplied unique identifier.

Specified by:: getGlossaryCategoryParent in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element
Returns:: parent glossary category element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossarySubCategories

public List<GlossaryCategoryElement> getGlossarySubCategories(String userId,
                                                              String assetManagerGUID,
                                                              String assetManagerName,
                                                              String glossaryCategoryGUID,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the glossary category metadata element with the supplied unique identifier.

Specified by:: getGlossarySubCategories in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of glossary category element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

createGlossaryTerm
```
public String createGlossaryTerm(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String glossaryGUID,
                                 String glossaryTermExternalIdentifier,
                                 String glossaryTermExternalIdentifierName,
                                 String glossaryTermExternalIdentifierUsage,
                                 String glossaryTermExternalIdentifierSource,
                                 KeyPattern glossaryTermExternalIdentifierKeyPattern,
                                 Map<String,String> mappingProperties,
                                 GlossaryTermProperties glossaryTermProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
Create a new metadata element to represent a glossary term.

Specified by:

createGlossaryTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryGUID - unique identifier of the glossary where the term is located

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

glossaryTermExternalIdentifierName - name of property for the external identifier in the external asset manager

glossaryTermExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager

glossaryTermExternalIdentifierSource - component that issuing this request.

glossaryTermExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)

mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata

glossaryTermProperties - properties for the glossary term

Returns:

unique identifier of the new metadata element for the glossary term

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

createControlledGlossaryTerm

public String createControlledGlossaryTerm(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String glossaryGUID,
                                           String glossaryTermExternalIdentifier,
                                           String glossaryTermExternalIdentifierName,
                                           String glossaryTermExternalIdentifierUsage,
                                           String glossaryTermExternalIdentifierSource,
                                           KeyPattern glossaryTermExternalIdentifierKeyPattern,
                                           Map<String,String> mappingProperties,
                                           GlossaryTermProperties glossaryTermProperties,
                                           GlossaryTermStatus initialStatus)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.

Specified by:: createControlledGlossaryTerm in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the glossary where the term is located; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager; glossaryTermExternalIdentifierName - name of property for the external identifier in the external asset manager; glossaryTermExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager; glossaryTermExternalIdentifierSource - component that issuing this request.; glossaryTermExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY); mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata; glossaryTermProperties - properties for the glossary term; initialStatus - glossary term status to use when the object is created
Returns:: unique identifier of the new metadata element for the glossary term
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

createGlossaryTermFromTemplate

public String createGlossaryTermFromTemplate(String userId,
                                             String assetManagerGUID,
                                             String assetManagerName,
                                             String templateGUID,
                                             String glossaryTermExternalIdentifier,
                                             String glossaryTermExternalIdentifierName,
                                             String glossaryTermExternalIdentifierUsage,
                                             String glossaryTermExternalIdentifierSource,
                                             KeyPattern glossaryTermExternalIdentifierKeyPattern,
                                             Map<String,String> mappingProperties,
                                             TemplateProperties templateProperties)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Create a new metadata element to represent a glossary term using an existing metadata element as a template.

Specified by:: createGlossaryTermFromTemplate in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; templateGUID - unique identifier of the metadata element to copy; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager; glossaryTermExternalIdentifierName - name of property for the external identifier in the external asset manager; glossaryTermExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager; glossaryTermExternalIdentifierSource - component that issuing this request.; glossaryTermExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY); mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata; templateProperties - properties that override the template
Returns:: unique identifier of the new metadata element for the glossary term
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

updateGlossaryTerm
```
public void updateGlossaryTerm(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier,
                               GlossaryTermProperties glossaryTermProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Update the metadata element representing a glossary term.

Specified by:

updateGlossaryTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the glossary term to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

glossaryTermProperties - new properties for the glossary term

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGlossaryTermStatus
```
public void updateGlossaryTermStatus(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String glossaryTermGUID,
                                     String glossaryTermExternalIdentifier,
                                     GlossaryTermStatus glossaryTermStatus)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.

Specified by:

updateGlossaryTermStatus in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the glossary term to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

glossaryTermStatus - new properties for the glossary term

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupTermCategory

public void setupTermCategory(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryCategoryGUID,
                              String glossaryTermGUID,
                              GlossaryTermCategorization categorizationProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Link a term to a category.

Specified by:: setupTermCategory in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the glossary category; glossaryTermGUID - unique identifier of the glossary term; categorizationProperties - properties for the categorization relationship
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermCategory
```
public void clearTermCategory(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryCategoryGUID,
                              String glossaryTermGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Unlink a term from a category.

Specified by:

clearTermCategory in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category

glossaryTermGUID - unique identifier of the glossary term

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupTermRelationship

public void setupTermRelationship(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String relationshipTypeName,
                                  String glossaryTermOneGUID,
                                  String glossaryTermTwoGUID,
                                  GlossaryTermRelationship relationshipsProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Link two terms together using a specialist relationship.

Specified by:: setupTermRelationship in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2; relationshipsProperties - properties for the relationship
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

updateTermRelationship

public void updateTermRelationship(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String relationshipTypeName,
                                   String glossaryTermOneGUID,
                                   String glossaryTermTwoGUID,
                                   GlossaryTermRelationship relationshipsProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Update the relationship properties for the two terms.

Specified by:: updateTermRelationship in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2; relationshipsProperties - properties for the relationship
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermRelationship

public void clearTermRelationship(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String relationshipTypeName,
                                  String glossaryTermOneGUID,
                                  String glossaryTermTwoGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the relationship between two terms.

Specified by:: clearTermRelationship in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsAbstractConcept
```
public void setTermAsAbstractConcept(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String glossaryTermGUID,
                                     String glossaryTermExternalIdentifier)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
Classify the glossary term to indicate that it describes an abstract concept.

Specified by:

setTermAsAbstractConcept in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsAbstractConcept

public void clearTermAsAbstractConcept(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String glossaryTermGUID,
                                       String glossaryTermExternalIdentifier)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the abstract concept designation from the glossary term.

Specified by:: clearTermAsAbstractConcept in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryTermGUID - unique identifier of the metadata element to update; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsDataValue
```
public void setTermAsDataValue(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Classify the glossary term to indicate that it describes a data value.

Specified by:

setTermAsDataValue in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsDataValue
```
public void clearTermAsDataValue(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String glossaryTermGUID,
                                 String glossaryTermExternalIdentifier)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
Remove the data value designation from the glossary term.

Specified by:

clearTermAsDataValue in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsActivity
```
public void setTermAsActivity(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryTermGUID,
                              String glossaryTermExternalIdentifier,
                              GlossaryTermActivityType activityType)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Classify the glossary term to indicate that it describes a data value.

Specified by:

setTermAsActivity in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

activityType - type of activity

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsActivity
```
public void clearTermAsActivity(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String glossaryTermGUID,
                                String glossaryTermExternalIdentifier)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
Remove the activity designation from the glossary term.

Specified by:

clearTermAsActivity in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsContext
```
public void setTermAsContext(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String glossaryTermGUID,
                             String glossaryTermExternalIdentifier,
                             GlossaryTermContextDefinition contextDefinition)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
Classify the glossary term to indicate that it describes a context.

Specified by:

setTermAsContext in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

contextDefinition - more details of the context

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsContext
```
public void clearTermAsContext(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Remove the context definition designation from the glossary term.

Specified by:

clearTermAsContext in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsSpineObject
```
public void setTermAsSpineObject(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String glossaryTermGUID,
                                 String glossaryTermExternalIdentifier)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
Classify the glossary term to indicate that it describes a spine object.

Specified by:

setTermAsSpineObject in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsSpineObject
```
public void clearTermAsSpineObject(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String glossaryTermGUID,
                                   String glossaryTermExternalIdentifier)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
Remove the spine object designation from the glossary term.

Specified by:

clearTermAsSpineObject in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsSpineAttribute
```
public void setTermAsSpineAttribute(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String glossaryTermGUID,
                                    String glossaryTermExternalIdentifier)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
```
Classify the glossary term to indicate that it describes a spine attribute.

Specified by:

setTermAsSpineAttribute in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsSpineAttribute

public void clearTermAsSpineAttribute(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String glossaryTermGUID,
                                      String glossaryTermExternalIdentifier)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Remove the spine attribute designation from the glossary term.

Specified by:: clearTermAsSpineAttribute in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryTermGUID - unique identifier of the metadata element to update; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

setTermAsObjectIdentifier
```
public void setTermAsObjectIdentifier(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String glossaryTermGUID,
                                      String glossaryTermExternalIdentifier)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
```
Classify the glossary term to indicate that it describes an object identifier.

Specified by:

setTermAsObjectIdentifier in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearTermAsObjectIdentifier

public void clearTermAsObjectIdentifier(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String glossaryTermGUID,
                                        String glossaryTermExternalIdentifier)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove the object identifier designation from the glossary term.

Specified by:: clearTermAsObjectIdentifier in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryTermGUID - unique identifier of the metadata element to update; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

removeGlossaryTerm
```
public void removeGlossaryTerm(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Remove the metadata element representing a glossary term.

Specified by:

removeGlossaryTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to remove

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGlossaryTerms

public List<GlossaryTermElement> findGlossaryTerms(String userId,
                                                   String assetManagerGUID,
                                                   String assetManagerName,
                                                   String searchString,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.

Specified by:: findGlossaryTerms in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getTermsForGlossary

public List<GlossaryTermElement> getTermsForGlossary(String userId,
                                                     String assetManagerGUID,
                                                     String assetManagerName,
                                                     String glossaryGUID,
                                                     int startFrom,
                                                     int pageSize)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the list of glossary terms associated with a glossary.

Specified by:: getTermsForGlossary in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryGUID - unique identifier of the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of associated metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getTermsForGlossaryCategory

public List<GlossaryTermElement> getTermsForGlossaryCategory(String userId,
                                                             String assetManagerGUID,
                                                             String assetManagerName,
                                                             String glossaryCategoryGUID,
                                                             int startFrom,
                                                             int pageSize)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Retrieve the list of glossary terms associated with a glossary category.

Specified by:: getTermsForGlossaryCategory in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryCategoryGUID - unique identifier of the glossary category of interest; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of associated metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryTermsByName

public List<GlossaryTermElement> getGlossaryTermsByName(String userId,
                                                        String assetManagerGUID,
                                                        String assetManagerName,
                                                        String name,
                                                        int startFrom,
                                                        int pageSize)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Specified by:: getGlossaryTermsByName in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryTermByGUID

public GlossaryTermElement getGlossaryTermByGUID(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String glossaryTermGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the glossary term metadata element with the supplied unique identifier.

Specified by:: getGlossaryTermByGUID in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; glossaryTermGUID - unique identifier of the requested metadata element
Returns:: matching metadata element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

createExternalGlossaryLink
```
public String createExternalGlossaryLink(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         ExternalGlossaryLinkProperties linkProperties)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
```
Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Specified by:

createExternalGlossaryLink in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

linkProperties - properties of the link

Returns:

unique identifier of the external reference

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateExternalGlossaryLink

public void updateExternalGlossaryLink(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String externalLinkGUID,
                                       ExternalGlossaryLinkProperties linkProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Update the properties of a reference to an external glossary resource.

Specified by:: updateExternalGlossaryLink in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the external reference; linkProperties - properties of the link
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

removeExternalGlossaryLink
```
public void removeExternalGlossaryLink(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String externalLinkGUID)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
```
Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).

Specified by:

removeExternalGlossaryLink in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

externalLinkGUID - unique identifier of the external reference

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

attachExternalLinkToGlossary

public void attachExternalLinkToGlossary(String userId,
                                         String assetManagerGUID,
                                         String assetManagerName,
                                         String externalLinkGUID,
                                         String glossaryGUID)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Connect a glossary to a reference to an external glossary resource.

Specified by:: attachExternalLinkToGlossary in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to attach
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

detachExternalLinkFromGlossary

public void detachExternalLinkFromGlossary(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String externalLinkGUID,
                                           String glossaryGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Disconnect a glossary from a reference to an external glossary resource.

Specified by:: detachExternalLinkFromGlossary in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to remove
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getExternalLinksForGlossary

public List<ExternalGlossaryLinkElement> getExternalLinksForGlossary(String userId,
                                                                     String glossaryGUID,
                                                                     int startFrom,
                                                                     int pageSize)
                                                              throws InvalidParameterException,
                                                                     UserNotAuthorizedException,
                                                                     PropertyServerException

Retrieve the list of links to external glossary resources attached to a glossary.

Specified by:: getExternalLinksForGlossary in interface GlossaryExchangeInterface
Parameters:: userId - calling user; glossaryGUID - unique identifier of the metadata element for the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of attached links to external glossary resources
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossariesForExternalLink

public List<GlossaryElement> getGlossariesForExternalLink(String userId,
                                                          String assetManagerGUID,
                                                          String assetManagerName,
                                                          String externalLinkGUID,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Return the glossaries connected to an external glossary source.

Specified by:: getGlossariesForExternalLink in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the metadata element for the external glossary link of interest; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of glossaries
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

attachExternalCategoryLink
```
public void attachExternalCategoryLink(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String externalLinkGUID,
                                       String glossaryCategoryGUID,
                                       ExternalGlossaryElementLinkProperties linkProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
```
Create a link to an external glossary category resource. This is associated with a category to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Specified by:

attachExternalCategoryLink in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryCategoryGUID - unique identifier for the the glossary category

linkProperties - properties of the link

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

detachExternalCategoryLink

public void detachExternalCategoryLink(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String externalLinkGUID,
                                       String glossaryCategoryGUID)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove the link to an external glossary category resource.

Specified by:: detachExternalCategoryLink in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryCategoryGUID - unique identifier for the the glossary category
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

attachExternalTermLink
```
public void attachExternalTermLink(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String externalLinkGUID,
                                   String glossaryTermGUID,
                                   ExternalGlossaryElementLinkProperties linkProperties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
Create a link to an external glossary term resource. This is associated with a term to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Specified by:

attachExternalTermLink in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryTermGUID - unique identifier for the the glossary category

linkProperties - properties of the link

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

detachExternalTermLink

public void detachExternalTermLink(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String externalLinkGUID,
                                   String glossaryTermGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the link to an external glossary term resource.

Specified by:: detachExternalTermLink in interface GlossaryExchangeInterface
Parameters:: userId - calling user; assetManagerGUID - unique identifier of software server capability representing the caller; assetManagerName - unique name of software server capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryTermGUID - unique identifier for the the glossary category
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

Class GlossaryExchangeClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryExchangeClient

GlossaryExchangeClient

GlossaryExchangeClient

GlossaryExchangeClient

GlossaryExchangeClient

Method Detail

createGlossary

createGlossaryFromTemplate

updateGlossary

setGlossaryAsTaxonomy

clearGlossaryAsTaxonomy

setGlossaryAsCanonical

clearGlossaryAsCanonical

removeGlossary

findGlossaries

getGlossariesByName

getGlossariesForAssetManager

getGlossaryByGUID

createGlossaryCategory

createGlossaryCategoryFromTemplate

updateGlossaryCategory

setupCategoryParent

clearCategoryParent

removeGlossaryCategory

findGlossaryCategories

getCategoriesForGlossary

getGlossaryCategoriesByName

getGlossaryCategoryByGUID

getGlossaryCategoryParent

getGlossarySubCategories

createGlossaryTerm

createControlledGlossaryTerm

createGlossaryTermFromTemplate

updateGlossaryTerm

updateGlossaryTermStatus

setupTermCategory

clearTermCategory

setupTermRelationship

updateTermRelationship

clearTermRelationship

setTermAsAbstractConcept

clearTermAsAbstractConcept

setTermAsDataValue

clearTermAsDataValue

setTermAsActivity

clearTermAsActivity

setTermAsContext

clearTermAsContext

setTermAsSpineObject

clearTermAsSpineObject

setTermAsSpineAttribute

clearTermAsSpineAttribute

setTermAsObjectIdentifier

clearTermAsObjectIdentifier

removeGlossaryTerm

findGlossaryTerms

getTermsForGlossary

getTermsForGlossaryCategory

getGlossaryTermsByName

getGlossaryTermByGUID

createExternalGlossaryLink

updateExternalGlossaryLink

removeExternalGlossaryLink

attachExternalLinkToGlossary

detachExternalLinkFromGlossary

getExternalLinksForGlossary

getGlossariesForExternalLink

attachExternalCategoryLink

detachExternalCategoryLink

attachExternalTermLink

detachExternalTermLink