Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.term

Interface GlossaryAuthorViewTerm

All Known Implementing Classes:
GlossaryAuthorViewTermClient
public interface GlossaryAuthorViewTerm

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term
    create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term)
    Create a Term.
    void
    delete(String userId, String guid)
    Delete a Term.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>
    find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Extract children within a Term
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term>
    findAll(String userId)
    Find Terms
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>
    getAllRelationships(String userId, String guid)
    Get a Term's relationships
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term
    getByGUID(String userId, String guid)
    Get a Term.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String termGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Extract Categories for a term
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategoryChildren(String userId, String parentGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Extract children within a Category
    org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig
    getConfig(String userId)
    Get config for server
    org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig
    getGlossaryAuthViewServiceConfig(String userId)
    Get service config for a particular view Service
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>
    getRelationships(String userId, String termGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Extract Relationships for a term
    List<org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig>
    getViewServiceConfigs(String userId)
    Get list of view service config on the server
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term
    restore(String userId, String guid)
    Restore a soft-deleted Term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term
    update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term)
    Update a Term.
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term
    update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term, boolean isReplace)
    Update a Term.

  • Method Details

    • create

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Create a Term.

      The result is the Term object

      Parameters:
      userId - userId under which the request is performed
      term - Term object to be created
      Returns:
      The Term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getByGUID

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term getByGUID(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Get a Term.

      The result is the requested Term object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Term object to be retrieved
      Returns:
      The requested Term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • update

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term, boolean isReplace) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update a Term.

      The result is the updated Glossary object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be updated
      term - Glossary object with updated values
      isReplace - If the object is to be replaced
      Returns:
      The updated Term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • update

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term term) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Update a Term.

      The result is the updated Glossary object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be updated
      term - Glossary object with updated values
      Returns:
      The updated Term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • delete

      void delete(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a Term.

      The result Void object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Term object to be retrieved
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.

    • restore

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term restore(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Restore a soft-deleted Term.

      The result is the restored Term object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Term object to be restored
      Returns:
      The restored Term
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getAllRelationships

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getAllRelationships(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Get a Term's relationships

      The result is a list of Relationships

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Term object to be retrieved
      Returns:
      The list of Term relationships
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getCategoryChildren

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategoryChildren(String userId, String parentGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Extract children within a Category
      Parameters:
      userId - calling user
      parentGuid - Category GUID
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      exactValue - exactValue - when false values with trailing characters will match.
      ignoreCase - ignore the case when matching.
      Returns:
      list of Categories
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • findAll

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> findAll(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Find Terms
      Parameters:
      userId - calling user
      Returns:
      Categories belonging to Userid
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • find

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term> find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Extract children within a Term
      Parameters:
      userId - calling user
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      exactValue - exactValue - when false values with trailing characters will match.
      ignoreCase - ignore the case when matching.
      Returns:
      list of Categories
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getCategories

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category> getCategories(String userId, String termGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Extract Categories for a term
      Parameters:
      userId - calling user
      termGuid - GUID for the term
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      Returns:
      list of Relationships
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getConfig

      org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig getConfig(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get config for server
      Parameters:
      userId - calling user
      Returns:
      Config for view server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getViewServiceConfigs

      List<org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig> getViewServiceConfigs(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get list of view service config on the server
      Parameters:
      userId - calling user
      Returns:
      Config for view server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getGlossaryAuthViewServiceConfig

      org.odpi.openmetadata.adminservices.configuration.properties.ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get service config for a particular view Service
      Parameters:
      userId - calling user
      Returns:
      Config for view server
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

    • getRelationships

      List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getRelationships(String userId, String termGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Extract Relationships for a term
      Parameters:
      userId - calling user
      termGuid - GUID for the term
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      Returns:
      list of Relationships
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - something went wrong with the REST call stack.
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid