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

Class GlossaryExchangeClient

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

org.odpi.openmetadata.accessservices.assetmanager.client.exchange.GlossaryExchangeClient

All Implemented Interfaces:

GlossaryExchangeInterface, ExternalIdentifierManagerInterface

public class GlossaryExchangeClient
extends AssetManagerBaseClient
implements GlossaryExchangeInterface

GlossaryExchangeClient is the client for managing resources from a glossary.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

assetManagerGUIDParameterName, assetManagerNameParameterName, invalidParameterHandler, metadataElementSummaryConverter, metadataRelationshipSummaryConverter, nullRequestBody, openMetadataStoreClient, propertyHelper, relatedMetadataElementSummaryConverter, restClient, serverName, serverPlatformURLRoot, urlTemplatePrefix

Constructor Summary

Constructors

Constructor	Description
GlossaryExchangeClient(String serverName, String serverPlatformURLRoot, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.
GlossaryExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)	Create a new client that passes userId and password in each HTTP request.
GlossaryExchangeClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize)	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, int maxPageSize)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

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

Methods inherited from class org.odpi.openmetadata.accessservices.assetmanager.client.AssetManagerBaseClient

addExternalIdentifier, addExternalIdentifier, clearRelationship, clearRelationship, confirmSynchronization, createFeedbackFromTemplateWithParent, createFeedbackWithParent, createReferenceable, createReferenceableFromTemplate, createReferenceableFromTemplate, createReferenceableFromTemplateWithParent, createReferenceableFromTemplateWithParent, createReferenceableWithParent, getAssetManagerIdentifiersRequestBody, getClassifiedElements, getClassifiedElements, getClassifiedElements, getClassifiedElements, getCorrelationProperties, getCorrelationProperties, getCorrelationProperties, getEffectiveTimeQueryRequestBody, getElementsForExternalIdentifier, getGlossaryTermRelationshipRequestBody, getMetadataCorrelationHeaders, getNameRequestBody, getNameRequestBody, getQualifiedNameRequestBody, getRelatedElements, getRelationshipRequestBody, getSearchStringRequestBody, getUpdateRequestBody, handleMissingScope, removeExternalIdentifier, removeReferenceable, removeReferenceableClassification, setReferenceableClassification, setupRelationship, setupRelationship, updateExternalIdentifier, updateFeedback, updateReferenceable

Methods inherited from class java.lang.Object

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

Constructor Details

GlossaryExchangeClient

public GlossaryExchangeClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog,
 int maxPageSize)
                       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 services

auditLog - logging destination

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GlossaryExchangeClient

public GlossaryExchangeClient(String serverName,
 String serverPlatformURLRoot,
 int maxPageSize)
                       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 services

maxPageSize - maximum value allowed for page size

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,
 int maxPageSize)
                       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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

maxPageSize - maximum value allowed for page size

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 services

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,
 int maxPageSize)
                       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 services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - maximum value allowed for page size

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

createGlossary

public String createGlossary(String userId,
 String assetManagerGUID,
 String assetManagerName,
 boolean assetManagerIsHome,
 ExternalIdentifierProperties externalIdentifierProperties,
 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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

externalIdentifierProperties - optional properties used to define an external identifier

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,
 boolean assetManagerIsHome,
 String templateGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 boolean deepCopy,
 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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

templateGUID - unique identifier of the metadata element to copy

externalIdentifierProperties - optional properties used to define an external identifier

deepCopy - should the template creation extend to the anchored elements or just the direct entity?

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,
 boolean isMergeUpdate,
 GlossaryProperties glossaryProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                    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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to update

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

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

glossaryProperties - new properties for this element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

setGlossaryAsEditingGlossary

public void setGlossaryAsEditingGlossary(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryGUID,
 String glossaryExternalIdentifier,
 EditingGlossaryProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.

Specified by:

setGlossaryAsEditingGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

properties - description of the purpose of the editing glossary

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

clearGlossaryAsEditingGlossary

public void clearGlossaryAsEditingGlossary(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryGUID,
 String glossaryExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the editing glossary classification from the glossary.

Specified by:

clearGlossaryAsEditingGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

setGlossaryAsStagingGlossary

public void setGlossaryAsStagingGlossary(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryGUID,
 String glossaryExternalIdentifier,
 StagingGlossaryProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into another glossary.

Specified by:

setGlossaryAsStagingGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

properties - description of the purpose of the editing glossary

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

clearGlossaryAsStagingGlossary

public void clearGlossaryAsStagingGlossary(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryGUID,
 String glossaryExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the staging glossary classification from the glossary.

Specified by:

clearGlossaryAsStagingGlossary in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 TaxonomyProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                           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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

properties - description of how the glossary is organized

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                             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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 CanonicalVocabularyProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                              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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                    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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                     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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned*

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                          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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                   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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                  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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

guid - unique identifier of the requested metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

matching metadata element

Throws:

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)

getGlossaryForCategory

public GlossaryElement getGlossaryForCategory(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryCategoryGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the glossary metadata element for the requested glossary category.

Specified by:

getGlossaryForCategory in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the requested category

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

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)

getGlossaryForTerm

public GlossaryElement getGlossaryForTerm(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the glossary metadata element for the requested glossary term.

Specified by:

getGlossaryForTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the requested term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

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,
 boolean assetManagerIsHome,
 String glossaryGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 GlossaryCategoryProperties glossaryCategoryProperties,
 boolean isRootCategory,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                              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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

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

externalIdentifierProperties - optional properties used to define an external identifier

glossaryCategoryProperties - properties about the glossary category to store

isRootCategory - is this category a root category?

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

unique identifier of the new glossary category

Throws:

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,
 boolean assetManagerIsHome,
 String glossaryGUID,
 String templateGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 boolean deepCopy,
 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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

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

templateGUID - unique identifier of the metadata element to copy

externalIdentifierProperties - optional properties used to define an external identifier

deepCopy - should the template creation extend to the anchored elements or just the direct entity?

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,
 boolean isMergeUpdate,
 GlossaryCategoryProperties glossaryCategoryProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software 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

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

glossaryCategoryProperties - new properties for the metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                         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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                         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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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 glossaryGUID,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                     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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - optional glossary unique identifier to scope the search to a glossary.

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                       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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary to query

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of metadata elements describing the categories associated with the requested glossary

Throws:

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)

getCategoriesForTerm

public List<GlossaryCategoryElement> getCategoriesForTerm(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of categories associated with a glossary term.

Specified by:

getCategoriesForTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the glossary term to query

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of metadata elements describing the categories associated with the requested term

Throws:

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 glossaryGUID,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                          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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - optional glossary unique identifier to scope the search to a glossary.

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                  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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the requested metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

requested metadata element

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                  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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the requested metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

parent glossary category element

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                       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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the requested metadata element

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of glossary category element

Throws:

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,
 boolean assetManagerIsHome,
 String glossaryGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 GlossaryTermProperties glossaryTermProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                          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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

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

externalIdentifierProperties - optional properties used to define an external identifier

glossaryTermProperties - properties for the glossary term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

unique identifier of the new metadata element for the glossary term

Throws:

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,
 boolean assetManagerIsHome,
 String glossaryGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 GlossaryTermProperties glossaryTermProperties,
 GlossaryTermStatus initialStatus,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

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

externalIdentifierProperties - optional properties used to define an external identifier

glossaryTermProperties - properties for the glossary term

initialStatus - glossary term status to use when the object is created

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

unique identifier of the new metadata element for the glossary term

Throws:

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,
 boolean assetManagerIsHome,
 String glossaryGUID,
 String templateGUID,
 ExternalIdentifierProperties externalIdentifierProperties,
 boolean deepCopy,
 GlossaryTermStatus initialStatus,
 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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

assetManagerIsHome - ensure that only the asset manager can update this element

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

templateGUID - unique identifier of the metadata element to copy

externalIdentifierProperties - optional properties used to define an external identifier

initialStatus - what status should the copy be set to

deepCopy - should the template creation extend to the anchored elements or just the direct entity?

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,
 boolean isMergeUpdate,
 GlossaryTermProperties glossaryTermProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                        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 capability representing the caller

assetManagerName - unique name of software 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

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

glossaryTermProperties - new properties for the glossary term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                              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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

updateGlossaryTermFromTemplate

public void updateGlossaryTermFromTemplate(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 String templateGUID,
 boolean isMergeClassifications,
 boolean isMergeProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the glossary term using the properties and classifications from the parentGUID stored in the request body.

Specified by:

updateGlossaryTermFromTemplate in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software 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

templateGUID - identifier for the template glossary term

isMergeClassifications - should the classification be merged or replace the target entity?

isMergeProperties - should the properties be merged with the existing ones or replace them

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

moveGlossaryTerm

public void moveGlossaryTerm(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 String newGlossaryGUID,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Move a glossary term from one glossary to another.

Specified by:

moveGlossaryTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software 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

newGlossaryGUID - identifier for the new glossary

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                       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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category

glossaryTermGUID - unique identifier of the glossary term

categorizationProperties - properties for the categorization relationship

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                       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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category

glossaryTermGUID - unique identifier of the glossary term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

getTermRelationshipTypeNames

public List<String> getTermRelationshipTypeNames(String userId)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of term-to-term relationship names.

Specified by:

getTermRelationshipTypeNames in interface GlossaryExchangeInterface

Parameters:

userId - calling user

Returns:

list of type names that are subtypes of asset

Throws:

InvalidParameterException - userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupTermRelationship

public void setupTermRelationship(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String relationshipTypeName,
 String glossaryTermOneGUID,
 String glossaryTermTwoGUID,
 GlossaryTermRelationship relationshipsProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                           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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                           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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                              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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

setTermAsDataField

public void setTermAsDataField(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 DataFieldValuesProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.

Specified by:

setTermAsDataField in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

properties - descriptive properties for the data field

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)

clearTermAsDataField

public void clearTermAsDataField(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the data field designation from the glossary term.

Specified by:

clearTermAsDataField in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                        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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                          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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 ActivityDescriptionProperties properties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                       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 capability representing the caller

assetManagerName - unique name of software 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

properties - type of activity

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                         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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                      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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                        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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                          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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                             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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                               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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                               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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                 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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

undoGlossaryTermUpdate

public GlossaryTermElement undoGlossaryTermUpdate(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Undo the last update to the glossary term.

Specified by:

undoGlossaryTermUpdate in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

recovered 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)

archiveGlossaryTerm

public void archiveGlossaryTerm(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String glossaryTermExternalIdentifier,
 ArchiveProperties archiveProperties,
 Date effectiveTime,
 boolean forDuplicateProcessing)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Archive the metadata element representing a glossary term. This removes it from normal access. However, it is still available for lineage requests.

Specified by:

archiveGlossaryTerm in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to archive

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

archiveProperties - option parameters about the archive process

effectiveTime - the time that the retrieved elements must be effective for

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                        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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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 glossaryGUID,
 String searchString,
 List<GlossaryTermStatus> limitResultsByStatus,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                            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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary to query

searchString - string to find in the properties

limitResultsByStatus - By default, terms in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                              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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary of interest

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of associated metadata elements

Throws:

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)

getRelatedTerms

public List<GlossaryTermElement> getRelatedTerms(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 String relationshipTypeName,
 List<GlossaryTermRelationshipStatus> limitResultsByStatus,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of glossary terms associated with the requested glossary term.

Specified by:

getRelatedTerms in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the glossary term of interest

relationshipTypeName - optional name of relationship

limitResultsByStatus - By default, term relationships in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of associated metadata elements

Throws:

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,
 List<GlossaryTermRelationshipStatus> limitResultsByStatus,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                      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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category of interest

limitResultsByStatus - By default, term relationships in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of associated metadata elements

Throws:

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 glossaryGUID,
 String name,
 List<GlossaryTermStatus> limitResultsByStatus,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                 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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary to query

name - name to search for

limitResultsByStatus - By default, terms in all statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of matching metadata elements

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                          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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the requested metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

matching metadata element

Throws:

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)

getGlossaryTermHistory

public List<GlossaryTermElement> getGlossaryTermHistory(String userId,
 String assetManagerGUID,
 String assetManagerName,
 String glossaryTermGUID,
 Date fromTime,
 Date toTime,
 int startFrom,
 int pageSize,
 boolean oldestFirst,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve all the versions of a glossary term.

Specified by:

getGlossaryTermHistory in interface GlossaryExchangeInterface

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of object to retrieve

fromTime - the earliest point in time from which to retrieve historical versions of the entity (inclusive)

toTime - the latest point in time from which to retrieve historical versions of the entity (exclusive)

startFrom - the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.

pageSize - the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.

oldestFirst - defining how the results should be ordered.

forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned

forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Returns:

list of beans

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem removing the properties from the repositories.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

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 capability representing the caller

assetManagerName - unique name of software 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,
 boolean isMergeUpdate,
 ExternalGlossaryLinkProperties linkProperties,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

linkProperties - properties of the link

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                  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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryGUID - unique identifier of the metadata element to attach

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                    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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryGUID - unique identifier of the metadata element to remove

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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 assetManagerGUID,
 String assetManagerName,
 String glossaryGUID,
 int startFrom,
 int pageSize,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                              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

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element for the glossary of interest

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of attached links to external glossary resources

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                                   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 capability representing the caller

assetManagerName - unique name of software 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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Returns:

list of glossaries

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryCategoryGUID - unique identifier for the glossary category

linkProperties - properties of the link

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                                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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryCategoryGUID - unique identifier for the glossary category

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryTermGUID - unique identifier for the glossary category

linkProperties - properties of the link

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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,
 Date effectiveTime,
 boolean forLineage,
 boolean forDuplicateProcessing)
                            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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryTermGUID - unique identifier for the glossary category

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)