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

Interface GlossaryAuthorViewSubjectAreaDefinitionCategory

All Known Implementing Classes:
GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
public interface GlossaryAuthorViewSubjectAreaDefinitionCategory

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition
    create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition subjectAreaDefinition)
    Create a subjectAreaDefinition.
    void
    delete(String userId, String guid)
    Delete a SubjectAreaDefinition.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition>
    find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Extract children within a SubjectAreaDefinition
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition>
    findAll(String userId)
    Find Category
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition
    getByGUID(String userId, String guid)
    Get a SubjectAreaDefinition.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String subjectAreaDefinitionGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Extract categories for a SubjectAreaDefinition
    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.adminservices.configuration.properties.ViewServiceConfig>
    getViewServiceConfigs(String userId)
    Get list of view service config on the server
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition
    restore(String userId, String guid)
    Restore a soft-deleted SubjectAreaDefinition.
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition
    update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition subjectAreaDefinition, boolean isReplace)
    Update a SubjectAreaDefinition.

  • Method Details

    • create

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

      The result is the subjectAreaDefinition object

      Parameters:
      userId - userId under which the request is performed
      subjectAreaDefinition - SubjectAreaDefinition object to be created
      Returns:
      The SubjectAreaDefinition
      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.category.SubjectAreaDefinition 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 SubjectAreaDefinition.

      The result is the requested SubjectAreaDefinition object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of SubjectAreaDefinition object to be retrieved
      Returns:
      The requested SubjectAreaDefinition
      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.category.SubjectAreaDefinition update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.SubjectAreaDefinition subjectAreaDefinition, 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 SubjectAreaDefinition.

      The result is the updated Glossary object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Glossary object to be updated
      subjectAreaDefinition - Glossary object with updated values
      isReplace - If the object is to be replaced
      Returns:
      The updated SubjectAreaDefinition
      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 SubjectAreaDefinition.

      The result Void object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of SubjectAreaDefinition 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.category.SubjectAreaDefinition 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 SubjectAreaDefinition.

      The result is the restored SubjectAreaDefinition object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of SubjectAreaDefinition object to be restored
      Returns:
      The restored SubjectAreaDefinition
      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.category.SubjectAreaDefinition> 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 Category
      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.category.SubjectAreaDefinition> 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 SubjectAreaDefinition
      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 subjectAreaDefinitionGuid, 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 SubjectAreaDefinition
      Parameters:
      userId - calling user
      subjectAreaDefinitionGuid - RelationShip GUID
      findRequest - information object for find calls. This include pageSize to limit the number of elements returned.
      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

    • 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