org.odpi.openmetadata.userinterface.uichassis.springboot.api.glossary

Class GlossaryViewController

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

org.odpi.openmetadata.userinterface.uichassis.springboot.api.glossary.GlossaryViewController

@RestController
 @RequestMapping(value="/api/glossaries")
public class GlossaryViewController
extends SecureController

This controller serves all requests for glossaries, categories and terms.

Constructor Summary

Constructors

Constructor and Description
GlossaryViewController()

Method Summary

Modifier and Type	Method and Description
List<Glossary>	getAllGlossaries(Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryCategory>	getAllGlossaryCategories(Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getAllGlossaryTerms(Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
GlossaryTerm	getAntonyms(String termGUID, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getAntonyms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getAssignedElements(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getAttributes(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryCategory>	getCategories(String glossaryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
GlossaryCategory	getCategory(String categoryGUID, javax.servlet.http.HttpServletRequest request)
Glossary	getCategoryHomeGlossary(String categoryGUID, javax.servlet.http.HttpServletRequest request)
List<ExternalGlossaryLink>	getExternalGlossaryLinks(String categoryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfGlossary(String glossaryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfTerm(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
Glossary	getGlossary(String glossaryGUID, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getIsATerms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getPreferredTerms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getRelatedTerms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getReplacementTerms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryCategory>	getSubcategories(String categoryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getSubtypes(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
Glossary	getSynonyms(String termGUID, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getSynonyms(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getTermsOfCategory(String categoryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getTermsOfGlossary(String glossaryGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getTranslations(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getTypes(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getUsedInContexts(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)
List<GlossaryTerm>	getValidValues(String termGUID, Integer from, Integer size, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

getUser

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryViewController

public GlossaryViewController()

Method Detail

getAllGlossaries

@GetMapping
public List<Glossary> getAllGlossaries(@RequestParam(defaultValue="0")
                                                   Integer from,
                                                   @RequestParam(defaultValue="100")
                                                   Integer size,
                                                   javax.servlet.http.HttpServletRequest request)
                                            throws GlossaryViewOmasException,
                                                   InvalidParameterException,
                                                   PropertyServerException

Parameters:

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossaries

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAllGlossaryTerms

@GetMapping(value="/terms")
public List<GlossaryTerm> getAllGlossaryTerms(@RequestParam(defaultValue="0")
                                                                          Integer from,
                                                                          @RequestParam(defaultValue="100")
                                                                          Integer size,
                                                                          javax.servlet.http.HttpServletRequest request)
                                                                   throws GlossaryViewOmasException,
                                                                          InvalidParameterException,
                                                                          PropertyServerException

Parameters:

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossary terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAllGlossaryCategories

@GetMapping(value="/categories")
public List<GlossaryCategory> getAllGlossaryCategories(@RequestParam(defaultValue="0")
                                                                                        Integer from,
                                                                                        @RequestParam(defaultValue="100")
                                                                                        Integer size,
                                                                                        javax.servlet.http.HttpServletRequest request)
                                                                                 throws GlossaryViewOmasException,
                                                                                        InvalidParameterException,
                                                                                        PropertyServerException

Parameters:

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossary categories

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getGlossary

@GetMapping(value="/{glossaryGUID}")
public Glossary getGlossary(@PathVariable(value="glossaryGUID")
                                                                 String glossaryGUID,
                                                                 javax.servlet.http.HttpServletRequest request)
                                                          throws GlossaryViewOmasException,
                                                                 InvalidParameterException,
                                                                 PropertyServerException

Parameters:

glossaryGUID - GUID of the glossary to be retrieved

Returns:

the glossary with the GUID or null

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategories

@GetMapping(value="/{glossaryGUID}/categories")
public List<GlossaryCategory> getCategories(@PathVariable(value="glossaryGUID")
                                                                                            String glossaryGUID,
                                                                                            @RequestParam(defaultValue="0")
                                                                                            Integer from,
                                                                                            @RequestParam(defaultValue="100")
                                                                                            Integer size,
                                                                                            javax.servlet.http.HttpServletRequest request)
                                                                                     throws GlossaryViewOmasException,
                                                                                            InvalidParameterException,
                                                                                            PropertyServerException

Parameters:

glossaryGUID - GUID of the glossary

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of categories

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTermsOfGlossary

@GetMapping(value="/{glossaryGUID}/terms")
public List<GlossaryTerm> getTermsOfGlossary(@PathVariable(value="glossaryGUID")
                                                                                        String glossaryGUID,
                                                                                        @RequestParam(defaultValue="0")
                                                                                        Integer from,
                                                                                        @RequestParam(defaultValue="100")
                                                                                        Integer size,
                                                                                        javax.servlet.http.HttpServletRequest request)
                                                                                 throws GlossaryViewOmasException,
                                                                                        InvalidParameterException,
                                                                                        PropertyServerException

Parameters:

glossaryGUID - GUID of the glossary

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfGlossary

@GetMapping(value="/{glossaryGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinksOfGlossary(@PathVariable(value="glossaryGUID")
                                                                                                                                String glossaryGUID,
                                                                                                                                @RequestParam(defaultValue="0")
                                                                                                                                Integer from,
                                                                                                                                @RequestParam(defaultValue="100")
                                                                                                                                Integer size,
                                                                                                                                javax.servlet.http.HttpServletRequest request)
                                                                                                                         throws GlossaryViewOmasException,
                                                                                                                                InvalidParameterException,
                                                                                                                                PropertyServerException

Parameters:

glossaryGUID - GUID of the glossary

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAntonyms

@GetMapping(value="/terms/{termGUID}")
public GlossaryTerm getAntonyms(@PathVariable(value="termGUID")
                                                                       String termGUID,
                                                                       javax.servlet.http.HttpServletRequest request)
                                                                throws GlossaryViewOmasException,
                                                                       InvalidParameterException,
                                                                       PropertyServerException

Parameters:

termGUID - GUID of the term

Returns:

the term with the GUID

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAntonyms

@GetMapping(value="/terms/{termGUID}/antonyms")
public List<GlossaryTerm> getAntonyms(@PathVariable(value="termGUID")
                                                                                      String termGUID,
                                                                                      @RequestParam(defaultValue="0")
                                                                                      Integer from,
                                                                                      @RequestParam(defaultValue="100")
                                                                                      Integer size,
                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                               throws GlossaryViewOmasException,
                                                                                      InvalidParameterException,
                                                                                      PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of antonyms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAssignedElements

@GetMapping(value="/terms/{termGUID}/assignedElements")
public List<GlossaryTerm> getAssignedElements(@PathVariable(value="termGUID")
                                                                                                      String termGUID,
                                                                                                      @RequestParam(defaultValue="0")
                                                                                                      Integer from,
                                                                                                      @RequestParam(defaultValue="100")
                                                                                                      Integer size,
                                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                                               throws GlossaryViewOmasException,
                                                                                                      InvalidParameterException,
                                                                                                      PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms representing the assigned elements

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getAttributes

@GetMapping(value="/terms/{termGUID}/attributes")
public List<GlossaryTerm> getAttributes(@PathVariable(value="termGUID")
                                                                                          String termGUID,
                                                                                          @RequestParam(defaultValue="0")
                                                                                          Integer from,
                                                                                          @RequestParam(defaultValue="100")
                                                                                          Integer size,
                                                                                          javax.servlet.http.HttpServletRequest request)
                                                                                   throws GlossaryViewOmasException,
                                                                                          InvalidParameterException,
                                                                                          PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms representing the antonyms of the term with GUID

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getIsATerms

@GetMapping(value="/terms/{termGUID}/isA")
public List<GlossaryTerm> getIsATerms(@PathVariable(value="termGUID")
                                                                                 String termGUID,
                                                                                 @RequestParam(defaultValue="0")
                                                                                 Integer from,
                                                                                 @RequestParam(defaultValue="100")
                                                                                 Integer size,
                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                          throws GlossaryViewOmasException,
                                                                                 InvalidParameterException,
                                                                                 PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of is-a terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getPreferredTerms

@GetMapping(value="/terms/{termGUID}/preferredTerms")
public List<GlossaryTerm> getPreferredTerms(@PathVariable(value="termGUID")
                                                                                                  String termGUID,
                                                                                                  @RequestParam(defaultValue="0")
                                                                                                  Integer from,
                                                                                                  @RequestParam(defaultValue="100")
                                                                                                  Integer size,
                                                                                                  javax.servlet.http.HttpServletRequest request)
                                                                                           throws GlossaryViewOmasException,
                                                                                                  InvalidParameterException,
                                                                                                  PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of preferred terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getRelatedTerms

@GetMapping(value="/terms/{termGUID}/relatedTerms")
public List<GlossaryTerm> getRelatedTerms(@PathVariable(value="termGUID")
                                                                                              String termGUID,
                                                                                              @RequestParam(defaultValue="0")
                                                                                              Integer from,
                                                                                              @RequestParam(defaultValue="100")
                                                                                              Integer size,
                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                       throws GlossaryViewOmasException,
                                                                                              InvalidParameterException,
                                                                                              PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of related terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getReplacementTerms

@GetMapping(value="/terms/{termGUID}/replacementTerms")
public List<GlossaryTerm> getReplacementTerms(@PathVariable(value="termGUID")
                                                                                                      String termGUID,
                                                                                                      @RequestParam(defaultValue="0")
                                                                                                      Integer from,
                                                                                                      @RequestParam(defaultValue="100")
                                                                                                      Integer size,
                                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                                               throws GlossaryViewOmasException,
                                                                                                      InvalidParameterException,
                                                                                                      PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of replacement terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSubtypes

@GetMapping(value="/terms/{termGUID}/subtypes")
public List<GlossaryTerm> getSubtypes(@PathVariable(value="termGUID")
                                                                                      String termGUID,
                                                                                      @RequestParam(defaultValue="0")
                                                                                      Integer from,
                                                                                      @RequestParam(defaultValue="100")
                                                                                      Integer size,
                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                               throws GlossaryViewOmasException,
                                                                                      InvalidParameterException,
                                                                                      PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of subtypes terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSynonyms

@GetMapping(value="/terms/{termGUID}/synonyms")
public List<GlossaryTerm> getSynonyms(@PathVariable(value="termGUID")
                                                                                      String termGUID,
                                                                                      @RequestParam(defaultValue="0")
                                                                                      Integer from,
                                                                                      @RequestParam(defaultValue="100")
                                                                                      Integer size,
                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                               throws GlossaryViewOmasException,
                                                                                      InvalidParameterException,
                                                                                      PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of synonym terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTranslations

@GetMapping(value="/terms/{termGUID}/translations")
public List<GlossaryTerm> getTranslations(@PathVariable(value="termGUID")
                                                                                              String termGUID,
                                                                                              @RequestParam(defaultValue="0")
                                                                                              Integer from,
                                                                                              @RequestParam(defaultValue="100")
                                                                                              Integer size,
                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                       throws GlossaryViewOmasException,
                                                                                              InvalidParameterException,
                                                                                              PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of translations terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTypes

@GetMapping(value="/terms/{termGUID}/types")
public List<GlossaryTerm> getTypes(@PathVariable(value="termGUID")
                                                                                String termGUID,
                                                                                @RequestParam(defaultValue="0")
                                                                                Integer from,
                                                                                @RequestParam(defaultValue="100")
                                                                                Integer size,
                                                                                javax.servlet.http.HttpServletRequest request)
                                                                         throws GlossaryViewOmasException,
                                                                                InvalidParameterException,
                                                                                PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of preferred terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getUsedInContexts

@GetMapping(value="/terms/{termGUID}/usedInContext")
public List<GlossaryTerm> getUsedInContexts(@PathVariable(value="termGUID")
                                                                                                 String termGUID,
                                                                                                 @RequestParam(defaultValue="0")
                                                                                                 Integer from,
                                                                                                 @RequestParam(defaultValue="100")
                                                                                                 Integer size,
                                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                                          throws GlossaryViewOmasException,
                                                                                                 InvalidParameterException,
                                                                                                 PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of "used-in-contexts" terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getValidValues

@GetMapping(value="/terms/{termGUID}/validValues")
public List<GlossaryTerm> getValidValues(@PathVariable(value="termGUID")
                                                                                            String termGUID,
                                                                                            @RequestParam(defaultValue="0")
                                                                                            Integer from,
                                                                                            @RequestParam(defaultValue="100")
                                                                                            Integer size,
                                                                                            javax.servlet.http.HttpServletRequest request)
                                                                                     throws GlossaryViewOmasException,
                                                                                            InvalidParameterException,
                                                                                            PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list valid values terms

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSynonyms

@GetMapping(value="/terms/{termGUID}/homeGlossary")
public Glossary getSynonyms(@PathVariable(value="termGUID")
                                                                                String termGUID,
                                                                                javax.servlet.http.HttpServletRequest request)
                                                                         throws GlossaryViewOmasException,
                                                                                InvalidParameterException,
                                                                                PropertyServerException

Parameters:

termGUID - GUID of the term

Returns:

term's home glossary

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfTerm

@GetMapping(value="/terms/{termGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinksOfTerm(@PathVariable(value="termGUID")
                                                                                                                              String termGUID,
                                                                                                                              @RequestParam(defaultValue="0")
                                                                                                                              Integer from,
                                                                                                                              @RequestParam(defaultValue="100")
                                                                                                                              Integer size,
                                                                                                                              javax.servlet.http.HttpServletRequest request)
                                                                                                                       throws GlossaryViewOmasException,
                                                                                                                              InvalidParameterException,
                                                                                                                              PropertyServerException

Parameters:

termGUID - GUID of the term

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of term's external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategory

@GetMapping(value="/categories/{categoryGUID}")
public GlossaryCategory getCategory(@PathVariable(value="categoryGUID")
                                                                                    String categoryGUID,
                                                                                    javax.servlet.http.HttpServletRequest request)
                                                                             throws GlossaryViewOmasException,
                                                                                    InvalidParameterException,
                                                                                    PropertyServerException

Parameters:

categoryGUID - GUID of the category to be retrieved

Returns:

the glossary category with the GUID or null

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getCategoryHomeGlossary

@GetMapping(value="/categories/{categoryGUID}/homeGlossary")
public Glossary getCategoryHomeGlossary(@PathVariable(value="categoryGUID")
                                                                                                     String categoryGUID,
                                                                                                     javax.servlet.http.HttpServletRequest request)
                                                                                              throws GlossaryViewOmasException,
                                                                                                     InvalidParameterException,
                                                                                                     PropertyServerException

Parameters:

categoryGUID - GUID of the category

request -

Returns:

the home glossary of the category

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getSubcategories

@GetMapping(value="/categories/{categoryGUID}/subcategories")
public List<GlossaryCategory> getSubcategories(@PathVariable(value="categoryGUID")
                                                                                                             String categoryGUID,
                                                                                                             @RequestParam(defaultValue="0")
                                                                                                             Integer from,
                                                                                                             @RequestParam(defaultValue="100")
                                                                                                             Integer size,
                                                                                                             javax.servlet.http.HttpServletRequest request)
                                                                                                      throws GlossaryViewOmasException,
                                                                                                             InvalidParameterException,
                                                                                                             PropertyServerException

Parameters:

categoryGUID - GUID of the category

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

the home glossary of the category

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getTermsOfCategory

@GetMapping(value="/categories/{categoryGUID}/terms")
public List<GlossaryTerm> getTermsOfCategory(@PathVariable(value="categoryGUID")
                                                                                                   String categoryGUID,
                                                                                                   @RequestParam(defaultValue="0")
                                                                                                   Integer from,
                                                                                                   @RequestParam(defaultValue="100")
                                                                                                   Integer size,
                                                                                                   javax.servlet.http.HttpServletRequest request)
                                                                                            throws GlossaryViewOmasException,
                                                                                                   InvalidParameterException,
                                                                                                   PropertyServerException

Parameters:

categoryGUID - GUID of the catgitegory

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms corresponding to the category

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend

getExternalGlossaryLinks

@GetMapping(value="/categories/{categoryGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinks(@PathVariable(value="categoryGUID")
                                                                                                                                 String categoryGUID,
                                                                                                                                 @RequestParam(defaultValue="0")
                                                                                                                                 Integer from,
                                                                                                                                 @RequestParam(defaultValue="100")
                                                                                                                                 Integer size,
                                                                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                                                                          throws GlossaryViewOmasException,
                                                                                                                                 InvalidParameterException,
                                                                                                                                 PropertyServerException

Parameters:

categoryGUID - GUID of the category

from - the index from witch the results to start, used for pagination

size - number of results returned, used for pagination

request -

Returns:

list of a category's external glossary links

Throws:

PropertyServerException - if a problem occurs while serving the request

InvalidParameterException - if parameter validation fails

GlossaryViewOmasException - if a problem occurs on the omas backend