Interface AssetConsumerGlossaryInterface

  • All Known Implementing Classes:
    AssetConsumer

    public interface AssetConsumerGlossaryInterface
    AssetConsumerGlossaryInterface supports the lookup of the meaning of a glossary term.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> findMeanings​(java.lang.String userId, java.lang.String term, int startFrom, int pageSize)
      Return the full definition (meaning) of the terms matching the supplied name.
      java.util.List<java.lang.String> getAssetsByMeaning​(java.lang.String userId, java.lang.String termGUID, int startFrom, int pageSize)
      Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
      org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement getMeaning​(java.lang.String userId, java.lang.String guid)
      Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
      java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> getMeaningByName​(java.lang.String userId, java.lang.String term, int startFrom, int pageSize)
      Return the full definition (meaning) of the terms exactly matching the supplied name.
    • Method Detail

      • getMeaning

        org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement getMeaning​(java.lang.String userId,
                                                                                              java.lang.String guid)
                                                                                       throws InvalidParameterException,
                                                                                              PropertyServerException,
                                                                                              UserNotAuthorizedException
        Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
        Parameters:
        userId - userId of the user making the request.
        guid - unique identifier of the glossary term.
        Returns:
        glossary term
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • getMeaningByName

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> getMeaningByName​(java.lang.String userId,
                                                                                                                    java.lang.String term,
                                                                                                                    int startFrom,
                                                                                                                    int pageSize)
                                                                                                             throws InvalidParameterException,
                                                                                                                    PropertyServerException,
                                                                                                                    UserNotAuthorizedException
        Return the full definition (meaning) of the terms exactly matching the supplied name.
        Parameters:
        userId - the name of the calling user.
        term - name of term.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of glossary terms
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • findMeanings

        java.util.List<org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement> findMeanings​(java.lang.String userId,
                                                                                                                java.lang.String term,
                                                                                                                int startFrom,
                                                                                                                int pageSize)
                                                                                                         throws InvalidParameterException,
                                                                                                                PropertyServerException,
                                                                                                                UserNotAuthorizedException
        Return the full definition (meaning) of the terms matching the supplied name.
        Parameters:
        userId - the name of the calling user.
        term - name of term. This may include wild card characters.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        list of glossary terms
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      • getAssetsByMeaning

        java.util.List<java.lang.String> getAssetsByMeaning​(java.lang.String userId,
                                                            java.lang.String termGUID,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            PropertyServerException,
                                                            UserNotAuthorizedException
        Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.
        Parameters:
        userId - the name of the calling user.
        termGUID - unique identifier of term.
        startFrom - index of the list to start from (0 for start)
        pageSize - maximum number of elements to return.
        Returns:
        asset guid list
        Throws:
        InvalidParameterException - the userId is null or invalid.
        PropertyServerException - there is a problem retrieving information from the property server(s).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.