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

Class CategoryService

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.CategoryService

public class CategoryService
extends GlossaryViewOMAS

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

Constructor Summary

Constructors

Constructor	Description
CategoryService()

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse	getAllCategories(String userId, String serverName, Integer from, Integer size)	Extract all categories definitions
org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse	getCategoriesViaCategoryAnchorRelationships(String userId, String serverName, String glossaryGUID, Integer from, Integer size)	Extract category definitions for the given glossary GUID via the 'CategoryAnchor' type relationships
org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse	getCategory(String userId, String serverName, String categoryGUID)	Extract the category definition for the given GUID
org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse	getExternalGlossaryLinks(String userId, String serverName, String categoryGUID, Integer from, Integer size)	Extract external glossary definitions for the given category
org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse	getSubcategories(String userId, String serverName, String categoryGUID, Integer from, Integer size)	Extract subcategory definitions for the given category

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryService

public CategoryService()

Method Details

getCategory

public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getCategory(String userId,
 String serverName,
 String categoryGUID)

Extract the category definition for the given GUID

Parameters:

userId - calling user

serverName - instance to call

categoryGUID - category GUID

Returns:

EntityDetailResponse category

getCategoriesViaCategoryAnchorRelationships

public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getCategoriesViaCategoryAnchorRelationships(String userId,
 String serverName,
 String glossaryGUID,
 Integer from,
 Integer size)

Extract category definitions for the given glossary GUID via the 'CategoryAnchor' type relationships

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 glossaries

getSubcategories

public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getSubcategories(String userId,
 String serverName,
 String categoryGUID,
 Integer from,
 Integer size)

Extract subcategory definitions for the given category

Parameters:

userId - calling user

serverName - instance to call

categoryGUID - category GUID

from - offset start for the return values

size - maximum number of results

Returns:

EntityDetailResponse subcategories

getExternalGlossaryLinks

public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getExternalGlossaryLinks(String userId,
 String serverName,
 String categoryGUID,
 Integer from,
 Integer size)

Extract external glossary definitions for the given category

Parameters:

userId - calling user

serverName - instance to call

categoryGUID - glossary GUID

from - offset start for the return values

size - maximum number of results

Returns:

EntityDetailResponse all external glossaries

getAllCategories

public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAllCategories(String userId,
 String serverName,
 Integer from,
 Integer size)

Extract all categories 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