org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class GlossaryTermHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.GlossaryTermHandler

public class GlossaryTermHandler
extends AttachmentHandlerBase

GlossaryHandler retrieves Glossary Term objects from the property server. It runs server-side in the AssetConsumer OMAS and retrieves Glossary Term entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

invalidParameterHandler, lastAttachmentHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

Constructor and Description
GlossaryTermHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, LastAttachmentHandler lastAttachmentHandler) Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
List<GlossaryTerm>	findMeanings(String userId, String name, int startFrom, int pageSize, String methodName) Returns the glossary term object corresponding to the supplied term name.
GlossaryTerm	getMeaning(String userId, String guid, String methodName) Returns the glossary term object corresponding to the supplied glossary term GUID.
List<GlossaryTerm>	getMeaningByName(String userId, String name, int startFrom, int pageSize, String methodName) Returns the glossary term object corresponding to the supplied term name.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

countAttachments, getAttachmentLinks, getAttachments

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryTermHandler

public GlossaryTermHandler(String serviceName,
                           String serverName,
                           InvalidParameterHandler invalidParameterHandler,
                           RepositoryHandler repositoryHandler,
                           OMRSRepositoryHelper repositoryHelper,
                           LastAttachmentHandler lastAttachmentHandler)

Construct the discovery engine configuration handler caching the objects needed to operate within a single server instance.

Parameters:

serviceName - name of the consuming service

serverName - name of this server instance

invalidParameterHandler - handler for invalid parameters

repositoryHelper - helper used by the converters

repositoryHandler - handler for calling the repository services

lastAttachmentHandler - handler for recording last attachment

Method Detail

getMeaningByName

public List<GlossaryTerm> getMeaningByName(String userId,
                                           String name,
                                           int startFrom,
                                           int pageSize,
                                           String methodName)
                                    throws InvalidParameterException,
                                           PropertyServerException,
                                           UserNotAuthorizedException

Returns the glossary term object corresponding to the supplied term name.

Parameters:

userId - String - userId of user making request.

name - this may be the qualifiedName or displayName of the term.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

methodName - calling method

Returns:

List of glossary terms retrieved from property server

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

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

findMeanings

public List<GlossaryTerm> findMeanings(String userId,
                                       String name,
                                       int startFrom,
                                       int pageSize,
                                       String methodName)
                                throws InvalidParameterException,
                                       PropertyServerException,
                                       UserNotAuthorizedException

Returns the glossary term object corresponding to the supplied term name.

Parameters:

userId - String - userId of user making request.

name - this may be the qualifiedName or displayName of the term.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

methodName - calling method

Returns:

List of glossary terms retrieved from property server

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

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

getMeaning

public GlossaryTerm getMeaning(String userId,
                               String guid,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Returns the glossary term object corresponding to the supplied glossary term GUID.

Parameters:

userId - String - userId of user making request.

guid - the unique id for the glossary term within the property server.

methodName - calling method

Returns:

Glossary Term retrieved from the property server

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property (metadata) server.

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