Class GlossaryViewClient


  • public class GlossaryViewClient
    extends FFDCRESTClient
    The Glossary View Open Metadata Access Service (OMAS) provides an interface to query for glossaries, categories and terms. Regarding the paged requests, one can pass null to 'from' and 'size' params in order to use their default values
    • Constructor Detail

      • GlossaryViewClient

        public GlossaryViewClient​(java.lang.String serverName,
                                  java.lang.String serverPlatformRootURL)
                           throws InvalidParameterException
        Create a new client
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - null URL or server name
        InvalidParameterException
      • GlossaryViewClient

        public GlossaryViewClient​(java.lang.String serverName,
                                  java.lang.String serverPlatformRootURL,
                                  java.lang.String userId,
                                  java.lang.String password)
                           throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformRootURL - the network address of the server running the OMAS REST servers
        userId - caller's userId embedded in all HTTP requests
        password - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - null URL or server name
        InvalidParameterException
    • Method Detail

      • getAllGlossaries

        public java.util.List<Glossary> getAllGlossaries​(java.lang.String userId,
                                                         java.lang.Integer from,
                                                         java.lang.Integer size)
                                                  throws PropertyServerException,
                                                         InvalidParameterException,
                                                         org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract all glossary definitions
        Parameters:
        userId - calling user
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse glossaries
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getAllGlossaryTerms

        public java.util.List<GlossaryTerm> getAllGlossaryTerms​(java.lang.String userId,
                                                                java.lang.Integer from,
                                                                java.lang.Integer size)
                                                         throws PropertyServerException,
                                                                InvalidParameterException,
                                                                org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract all glossaryTerms definitions
        Parameters:
        userId - calling user
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse glossaries
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getAllCategories

        public java.util.List<GlossaryCategory> getAllCategories​(java.lang.String userId,
                                                                 java.lang.Integer from,
                                                                 java.lang.Integer size)
                                                          throws PropertyServerException,
                                                                 InvalidParameterException,
                                                                 org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract all categories definitions
        Parameters:
        userId - calling user
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse glossaries
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getGlossary

        public Glossary getGlossary​(java.lang.String userId,
                                    java.lang.String glossaryGUID)
                             throws PropertyServerException,
                                    InvalidParameterException,
                                    org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a glossary definition
        Parameters:
        userId - calling user
        glossaryGUID - glossary GUID
        Returns:
        EntityDetailResponse glossary
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTermHomeGlossary

        public Glossary getTermHomeGlossary​(java.lang.String userId,
                                            java.lang.String termGUID)
                                     throws PropertyServerException,
                                            InvalidParameterException,
                                            org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a term's home glossary
        Parameters:
        userId - calling user
        termGUID - term GUID
        Returns:
        EntityDetailResponse glossary
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getCategoryHomeGlossary

        public Glossary getCategoryHomeGlossary​(java.lang.String userId,
                                                java.lang.String categoryGUID)
                                         throws PropertyServerException,
                                                InvalidParameterException,
                                                org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a category's home glossary
        Parameters:
        userId - calling user
        categoryGUID - category GUID
        Returns:
        EntityDetailResponse glossary
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getExternalGlossaryLinksOfGlossary

        public java.util.List<ExternalGlossaryLink> getExternalGlossaryLinksOfGlossary​(java.lang.String userId,
                                                                                       java.lang.String glossaryGUID,
                                                                                       java.lang.Integer from,
                                                                                       java.lang.Integer size)
                                                                                throws PropertyServerException,
                                                                                       InvalidParameterException,
                                                                                       org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a glossaries's external glossary links
        Parameters:
        userId - calling user
        glossaryGUID - glossary GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse external glossary links
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getCategory

        public GlossaryCategory getCategory​(java.lang.String userId,
                                            java.lang.String categoryGUID)
                                     throws PropertyServerException,
                                            InvalidParameterException,
                                            org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a category definition
        Parameters:
        userId - calling user
        categoryGUID - category GUID
        Returns:
        EntityDetailResponse category
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getCategories

        public java.util.List<GlossaryCategory> getCategories​(java.lang.String userId,
                                                              java.lang.String glossaryGUID,
                                                              java.lang.Integer from,
                                                              java.lang.Integer size)
                                                       throws PropertyServerException,
                                                              InvalidParameterException,
                                                              org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract categories within a glossary
        Parameters:
        userId - calling user
        glossaryGUID - glossary GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse categories
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getSubcategories

        public java.util.List<GlossaryCategory> getSubcategories​(java.lang.String userId,
                                                                 java.lang.String categoryGUID,
                                                                 java.lang.Integer from,
                                                                 java.lang.Integer size)
                                                          throws PropertyServerException,
                                                                 InvalidParameterException,
                                                                 org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract subcategories of a category
        Parameters:
        userId - calling user
        categoryGUID - category GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse subcategories
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getExternalGlossaryLinksOfCategory

        public java.util.List<ExternalGlossaryLink> getExternalGlossaryLinksOfCategory​(java.lang.String userId,
                                                                                       java.lang.String categoryGUID,
                                                                                       java.lang.Integer from,
                                                                                       java.lang.Integer size)
                                                                                throws PropertyServerException,
                                                                                       InvalidParameterException,
                                                                                       org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a category's external glossary links
        Parameters:
        userId - calling user
        categoryGUID - category GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse external glossary links
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTerm

        public GlossaryTerm getTerm​(java.lang.String userId,
                                    java.lang.String termGUID)
                             throws PropertyServerException,
                                    InvalidParameterException,
                                    org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a term definition
        Parameters:
        userId - calling user
        termGUID - term GUID
        Returns:
        EntityDetailResponse term
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTermsOfGlossary

        public java.util.List<GlossaryTerm> getTermsOfGlossary​(java.lang.String userId,
                                                               java.lang.String glossaryGUID,
                                                               java.lang.Integer from,
                                                               java.lang.Integer size)
                                                        throws PropertyServerException,
                                                               InvalidParameterException,
                                                               org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract terms within a glossary
        Parameters:
        userId - calling user
        glossaryGUID - glossary GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTermsOfCategory

        public java.util.List<GlossaryTerm> getTermsOfCategory​(java.lang.String userId,
                                                               java.lang.String categoryGUID,
                                                               java.lang.Integer from,
                                                               java.lang.Integer size)
                                                        throws PropertyServerException,
                                                               InvalidParameterException,
                                                               org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract terms within a category
        Parameters:
        userId - calling user
        categoryGUID - category GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getExternalGlossaryLinksOfTerm

        public java.util.List<ExternalGlossaryLink> getExternalGlossaryLinksOfTerm​(java.lang.String userId,
                                                                                   java.lang.String termGUID,
                                                                                   java.lang.Integer from,
                                                                                   java.lang.Integer size)
                                                                            throws PropertyServerException,
                                                                                   InvalidParameterException,
                                                                                   org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract a term's external glossary links
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse external glossary links
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getRelatedTerms

        public java.util.List<GlossaryTerm> getRelatedTerms​(java.lang.String userId,
                                                            java.lang.String termGUID,
                                                            java.lang.Integer from,
                                                            java.lang.Integer size)
                                                     throws PropertyServerException,
                                                            InvalidParameterException,
                                                            org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract related terms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getSynonyms

        public java.util.List<GlossaryTerm> getSynonyms​(java.lang.String userId,
                                                        java.lang.String termGUID,
                                                        java.lang.Integer from,
                                                        java.lang.Integer size)
                                                 throws PropertyServerException,
                                                        InvalidParameterException,
                                                        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract synonyms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getAntonyms

        public java.util.List<GlossaryTerm> getAntonyms​(java.lang.String userId,
                                                        java.lang.String termGUID,
                                                        java.lang.Integer from,
                                                        java.lang.Integer size)
                                                 throws PropertyServerException,
                                                        InvalidParameterException,
                                                        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract antonyms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getPreferredTerms

        public java.util.List<GlossaryTerm> getPreferredTerms​(java.lang.String userId,
                                                              java.lang.String termGUID,
                                                              java.lang.Integer from,
                                                              java.lang.Integer size)
                                                       throws PropertyServerException,
                                                              InvalidParameterException,
                                                              org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract preferred terms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getReplacementTerms

        public java.util.List<GlossaryTerm> getReplacementTerms​(java.lang.String userId,
                                                                java.lang.String termGUID,
                                                                java.lang.Integer from,
                                                                java.lang.Integer size)
                                                         throws PropertyServerException,
                                                                InvalidParameterException,
                                                                org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract replacement terms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTranslations

        public java.util.List<GlossaryTerm> getTranslations​(java.lang.String userId,
                                                            java.lang.String termGUID,
                                                            java.lang.Integer from,
                                                            java.lang.Integer size)
                                                     throws PropertyServerException,
                                                            InvalidParameterException,
                                                            org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract translations
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getIsA

        public java.util.List<GlossaryTerm> getIsA​(java.lang.String userId,
                                                   java.lang.String termGUID,
                                                   java.lang.Integer from,
                                                   java.lang.Integer size)
                                            throws PropertyServerException,
                                                   InvalidParameterException,
                                                   org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract "is-a" terms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getValidValues

        public java.util.List<GlossaryTerm> getValidValues​(java.lang.String userId,
                                                           java.lang.String termGUID,
                                                           java.lang.Integer from,
                                                           java.lang.Integer size)
                                                    throws PropertyServerException,
                                                           InvalidParameterException,
                                                           org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract valid values
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getUsedInContexts

        public java.util.List<GlossaryTerm> getUsedInContexts​(java.lang.String userId,
                                                              java.lang.String termGUID,
                                                              java.lang.Integer from,
                                                              java.lang.Integer size)
                                                       throws PropertyServerException,
                                                              InvalidParameterException,
                                                              org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract "used-in-contexts" terms
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getAssignedElements

        public java.util.List<GlossaryTerm> getAssignedElements​(java.lang.String userId,
                                                                java.lang.String termGUID,
                                                                java.lang.Integer from,
                                                                java.lang.Integer size)
                                                         throws PropertyServerException,
                                                                InvalidParameterException,
                                                                org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract assigned elements
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getAttributes

        public java.util.List<GlossaryTerm> getAttributes​(java.lang.String userId,
                                                          java.lang.String termGUID,
                                                          java.lang.Integer from,
                                                          java.lang.Integer size)
                                                   throws PropertyServerException,
                                                          InvalidParameterException,
                                                          org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract attributes
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getSubtypes

        public java.util.List<GlossaryTerm> getSubtypes​(java.lang.String userId,
                                                        java.lang.String termGUID,
                                                        java.lang.Integer from,
                                                        java.lang.Integer size)
                                                 throws PropertyServerException,
                                                        InvalidParameterException,
                                                        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract subtypes
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend
      • getTypes

        public java.util.List<GlossaryTerm> getTypes​(java.lang.String userId,
                                                     java.lang.String termGUID,
                                                     java.lang.Integer from,
                                                     java.lang.Integer size)
                                              throws PropertyServerException,
                                                     InvalidParameterException,
                                                     org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException
        Extract types
        Parameters:
        userId - calling user
        termGUID - term GUID
        from - starting index
        size - max number of returned entities
        Returns:
        EntityDetailResponse terms
        Throws:
        PropertyServerException - if a problem occurs while serving the request
        InvalidParameterException - if parameter validation fails
        org.odpi.openmetadata.accessservices.glossaryview.exception.GlossaryViewOmasException - if a problem occurs on the omas backend