Package org.odpi.openmetadata.accessservices.assetconsumer.api

Interface AssetConsumerGlossaryInterface

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

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement>
    findMeanings(String userId, String term, int startFrom, int pageSize)
    Return the full definition (meaning) of the terms matching the supplied name.
    List<String>
    getAssetsByMeaning(String userId, 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.frameworks.openmetadata.metadataelements.MeaningElement
    getMeaning(String userId, String guid)
    Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement>
    getMeaningByName(String userId, String term, int startFrom, int pageSize)
    Return the full definition (meaning) of the terms exactly matching the supplied name.

  • Method Details

    • getMeaning

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement getMeaning(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getMeaningByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement> getMeaningByName(String userId, String term, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findMeanings

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.MeaningElement> findMeanings(String userId, String term, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getAssetsByMeaning

      List<String> getAssetsByMeaning(String userId, String termGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the userId is null or invalid.
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.