Package org.odpi.openmetadata.accessservices.glossaryview.server.service

Class GlossaryService

java.lang.Object

org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

org.odpi.openmetadata.accessservices.glossaryview.server.service.GlossaryViewOMAS

org.odpi.openmetadata.accessservices.glossaryview.server.service.GlossaryService

public class GlossaryService
extends GlossaryViewOMAS

Server-side implementation of the Glossary View Open Metadata Access Service (OMAS). Deals in extracting glossaries

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

instanceHandler

Constructor Summary

Constructors

Constructor	Description
GlossaryService()

Method Summary

Modifier and Type	Method	Description
GlossaryViewEntityDetailResponse	getAllGlossaries(String userId, String serverName, Integer from, Integer size)	Extract all glossary definitions
GlossaryViewEntityDetailResponse	getCategoryHomeGlossary(String userId, String serverName, String categoryGUID)	Extract a category's home glossary
GlossaryViewEntityDetailResponse	getExternalGlossaryLinks(String userId, String serverName, String glossaryGUID, Integer from, Integer size)	Extract external glossary link definitions
GlossaryViewEntityDetailResponse	getGlossary(String userId, String serverName, String glossaryGUID)	Extract the glossary definition for the given GUID
GlossaryViewEntityDetailResponse	getTermHomeGlossary(String userId, String serverName, String termGUID)	Extract a term's home glossary

Methods inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.GlossaryViewOMAS

getAllEntityDetailsResponse, getEntityDetailResponse, getRelatedEntitiesResponse, getSubEntitiesResponse

Methods inherited from class org.odpi.openmetadata.accessservices.glossaryview.server.service.OMRSClient

getAllEntityDetails, getEntityDetail, getRelatedEntities, getSubEntities

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryService

public GlossaryService()

Method Detail

getGlossary

public GlossaryViewEntityDetailResponse getGlossary(String userId,
                                                    String serverName,
                                                    String glossaryGUID)

Extract the glossary definition for the given GUID

Parameters:

userId - calling user

serverName - instance to call

glossaryGUID - glossary GUID

Returns:

EntityDetailResponse glossary

getAllGlossaries

public GlossaryViewEntityDetailResponse getAllGlossaries(String userId,
                                                         String serverName,
                                                         Integer from,
                                                         Integer size)

Extract all glossary definitions

Parameters:

userId - calling user

serverName - instance to call

from - offset start for the return values

size - maximum number of results

Returns:

EntityDetailResponse all glossaries

getTermHomeGlossary

public GlossaryViewEntityDetailResponse getTermHomeGlossary(String userId,
                                                            String serverName,
                                                            String termGUID)

Extract a term's home glossary

Parameters:

userId - calling user

serverName - instance to call

termGUID - term GUID

Returns:

glossary

getCategoryHomeGlossary

public GlossaryViewEntityDetailResponse getCategoryHomeGlossary(String userId,
                                                                String serverName,
                                                                String categoryGUID)

Extract a category's home glossary

Parameters:

userId - calling user

serverName - instance to call

categoryGUID - term GUID

Returns:

glossary

getExternalGlossaryLinks

public GlossaryViewEntityDetailResponse getExternalGlossaryLinks(String userId,
                                                                 String serverName,
                                                                 String glossaryGUID,
                                                                 Integer from,
                                                                 Integer size)

Extract external glossary link definitions

Parameters:

userId - calling user

serverName - instance to call

glossaryGUID - glossary GUID

from - offset start for the return values

size - maximum number of results

Returns:

EntityDetailResponse all external glossary links