GlossaryCategoryHandler (Generic Handler Services 2.8 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
- - org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
 - - org.odpi.openmetadata.commonservices.generichandlers.GlossaryCategoryHandler

Type Parameters:

B - class that represents the glossary category
```
public class GlossaryCategoryHandler
extends ReferenceableHandler
```
GlossaryCategoryHandler provides the exchange of metadata about glossary categories between the repository and the OMAS. Note glossary categories are governance metadata and are always defined with LOCAL-COHORT provenance.

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
  auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors
Constructor and Description
`GlossaryCategoryHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)` Construct the asset handler with information needed to work with B objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryParentCategoryGUIDParameterName, String glossaryChildCategoryGUID, String glossaryChildCategoryGUIDParameterName, String methodName)` Remove a parent-child relationship between two categories.
`String`	`createGlossaryCategory(String userId, String glossaryGUID, String glossaryGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)` Create the glossary category object.
`String`	`createGlossaryCategoryFromTemplate(String userId, String templateGUID, String qualifiedName, String displayName, String description, String methodName)` Create a new metadata element to represent a glossary category using an existing metadata element as a template.
`List<B>`	`findGlossaryCategories(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, String methodName)` Retrieve the list of glossary category metadata elements that contain the search string.
`List<B>`	`getCategoriesForGlossary(String userId, String glossaryGUID, String glossaryGUIDParameterName, int startFrom, int pageSize, String methodName)` Return the list of categories associated with a glossary.
`List<B>`	`getGlossaryCategoriesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName)` Retrieve the list of glossary metadata elements with a matching qualified or display name.
`B`	`getGlossaryCategoryByGUID(String userId, String guid, String guidParameterName, String methodName)` Retrieve the glossary metadata element with the supplied unique identifier.
`B`	`getGlossaryCategoryParent(String userId, String glossaryCategoryGUID, String glossaryCategoryGUIDParameterName, String methodName)` Retrieve the glossary category metadata element with the supplied unique identifier.
`List<B>`	`getGlossarySubCategories(String userId, String glossaryCategoryGUID, String glossaryCategoryGUIDParameterName, int startFrom, int pageSize, String methodName)` Retrieve the glossary category metadata element with the supplied unique identifier.
`void`	`removeGlossaryCategory(String userId, String glossaryCategoryGUID, String glossaryCategoryGUIDParameterName, String methodName)` Remove the metadata element representing a glossary category.
`void`	`setupCategoryParent(String userId, String glossaryParentCategoryGUID, String glossaryParentCategoryGUIDParameterName, String glossaryChildCategoryGUID, String glossaryChildCategoryGUIDParameterName, String methodName)` Create a parent-child relationship between two categories.
`void`	`updateGlossaryCategory(String userId, String glossaryCategoryGUID, String glossaryCategoryGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)` Create the anchor object that all elements in a glossary (terms and categories) are linked to.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

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

Constructor Detail

GlossaryCategoryHandler

public GlossaryCategoryHandler(OpenMetadataAPIGenericConverter<B> converter,
                               Class<B> beanClass,
                               String serviceName,
                               String serverName,
                               InvalidParameterHandler invalidParameterHandler,
                               RepositoryHandler repositoryHandler,
                               OMRSRepositoryHelper repositoryHelper,
                               String localServerUserId,
                               OpenMetadataServerSecurityVerifier securityVerifier,
                               List<String> supportedZones,
                               List<String> defaultZones,
                               List<String> publishZones,
                               AuditLog auditLog)

Construct the asset handler with information needed to work with B objects.

Parameters:: converter - specific converter for this bean class; beanClass - name of bean class that is represented by the generic class B; serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects; localServerUserId - userId for this server; securityVerifier - open metadata security services verifier; supportedZones - list of zones that the access service is allowed to serve B instances from; defaultZones - list of zones that the access service should set in all new B instances; publishZones - list of zones that the access service sets up in published B instances; auditLog - destination for audit log events

Method Detail

createGlossaryCategory

public String createGlossaryCategory(String userId,
                                     String glossaryGUID,
                                     String glossaryGUIDParameterName,
                                     String qualifiedName,
                                     String displayName,
                                     String description,
                                     Map<String,String> additionalProperties,
                                     String suppliedTypeName,
                                     Map<String,Object> extendedProperties,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Create the glossary category object.

Parameters:: userId - calling user; glossaryGUID - unique identifier of the owning glossary; glossaryGUIDParameterName - parameter supplying glossaryGUID; qualifiedName - unique name for the category - used in other configuration; displayName - short display name for the category; description - description of the category; additionalProperties - additional properties for a category; suppliedTypeName - type name from the caller (enables creation of subtypes); extendedProperties - properties for a category subtype; methodName - calling method
Returns:: unique identifier of the new glossary object
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createGlossaryCategoryFromTemplate

public String createGlossaryCategoryFromTemplate(String userId,
                                                 String templateGUID,
                                                 String qualifiedName,
                                                 String displayName,
                                                 String description,
                                                 String methodName)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Create a new metadata element to represent a glossary category using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new category. This includes its link to the glossary.

Parameters:: userId - calling user; templateGUID - unique identifier of the metadata element to copy; qualifiedName - unique name for the category - used in other configuration; displayName - short display name for the category; description - description of the category; methodName - calling method
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)

updateGlossaryCategory

public void updateGlossaryCategory(String userId,
                                   String glossaryCategoryGUID,
                                   String glossaryCategoryGUIDParameterName,
                                   String qualifiedName,
                                   String displayName,
                                   String description,
                                   Map<String,String> additionalProperties,
                                   String suppliedTypeName,
                                   Map<String,Object> extendedProperties,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create the anchor object that all elements in a glossary (terms and categories) are linked to.

Parameters:: userId - calling user; glossaryCategoryGUID - unique identifier for the category to update; glossaryCategoryGUIDParameterName - parameter supplying the category; qualifiedName - unique name for the category - used in other configuration; displayName - short display name for the category; description - description of the governance category; additionalProperties - additional properties for a governance category; suppliedTypeName - type of term; extendedProperties - properties for a governance category subtype; methodName - calling method
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

setupCategoryParent

public void setupCategoryParent(String userId,
                                String glossaryParentCategoryGUID,
                                String glossaryParentCategoryGUIDParameterName,
                                String glossaryChildCategoryGUID,
                                String glossaryChildCategoryGUIDParameterName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create a parent-child relationship between two categories.

Parameters:: userId - calling user; glossaryParentCategoryGUID - unique identifier of the glossary super-category; glossaryParentCategoryGUIDParameterName - parameter supplying the super-category; glossaryChildCategoryGUID - unique identifier of the glossary subcategory; glossaryChildCategoryGUIDParameterName - parameter supplying the subcategory; methodName - calling method
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 glossaryParentCategoryGUID,
                                String glossaryParentCategoryGUIDParameterName,
                                String glossaryChildCategoryGUID,
                                String glossaryChildCategoryGUIDParameterName,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove a parent-child relationship between two categories.

Parameters:: userId - calling user; glossaryParentCategoryGUID - unique identifier of the glossary super-category; glossaryParentCategoryGUIDParameterName - parameter supplying the super-category; glossaryChildCategoryGUID - unique identifier of the glossary subcategory; glossaryChildCategoryGUIDParameterName - parameter supplying the subcategory; methodName - calling method
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 glossaryCategoryGUID,
                                   String glossaryCategoryGUIDParameterName,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the metadata element representing a glossary category.

Parameters:: userId - calling user; glossaryCategoryGUID - unique identifier of the metadata element to remove; glossaryCategoryGUIDParameterName - parameter for glossaryCategoryGUID; methodName - calling method
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<B> findGlossaryCategories(String userId,
                                      String searchString,
                                      String searchStringParameterName,
                                      int startFrom,
                                      int pageSize,
                                      String methodName)
                               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.

Parameters:: userId - calling user; searchString - string to find in the properties; searchStringParameterName - name of parameter supplying the search string; startFrom - paging start point; pageSize - maximum results that can be returned; methodName - calling method
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<B> getCategoriesForGlossary(String userId,
                                        String glossaryGUID,
                                        String glossaryGUIDParameterName,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return the list of categories associated with a glossary.

Parameters:: userId - calling user; glossaryGUID - unique identifier of the glossary to query; glossaryGUIDParameterName - name of the parameter supplying glossaryGUID; startFrom - paging start point; pageSize - maximum results that can be returned; methodName - calling method
Returns:: list of metadata elements describing the categories associated with the requested glossary
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getGlossaryCategoriesByName

public List<B> getGlossaryCategoriesByName(String userId,
                                           String name,
                                           String nameParameterName,
                                           int startFrom,
                                           int pageSize,
                                           String methodName)
                                    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.

Parameters:: userId - calling user; name - name to search for; nameParameterName - parameter supplying name; startFrom - paging start point; pageSize - maximum results that can be returned; methodName - calling method
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)

getGlossaryCategoryParent

public B getGlossaryCategoryParent(String userId,
                                   String glossaryCategoryGUID,
                                   String glossaryCategoryGUIDParameterName,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

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

Parameters:: userId - calling user; glossaryCategoryGUID - unique identifier of the requested metadata element; glossaryCategoryGUIDParameterName - parameter name of the glossaryCategoryGUID; methodName - calling method
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<B> getGlossarySubCategories(String userId,
                                        String glossaryCategoryGUID,
                                        String glossaryCategoryGUIDParameterName,
                                        int startFrom,
                                        int pageSize,
                                        String methodName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

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

Parameters:: userId - calling user; glossaryCategoryGUID - unique identifier of the requested metadata element; glossaryCategoryGUIDParameterName - parameter name of the glossaryCategoryGUID; startFrom - paging start point; pageSize - maximum results that can be returned; methodName - calling method
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)

getGlossaryCategoryByGUID

public B getGlossaryCategoryByGUID(String userId,
                                   String guid,
                                   String guidParameterName,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Retrieve the glossary metadata element with the supplied unique identifier.

Parameters:: userId - calling user; guid - unique identifier of the requested metadata element; guidParameterName - parameter name of guid; methodName - calling method
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)

Class GlossaryCategoryHandler<B>

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler