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

Interface GlossaryAuthorViewGraph

All Known Implementing Classes:
GlossaryAuthorViewGraphClient
public interface GlossaryAuthorViewGraph

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph
    create(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph)
    Create a Graph.
    void
    delete(String userId, String guid)
    Delete a Graph.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>
    find(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, boolean exactValue, boolean ignoreCase)
    Find graphs
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph>
    findAll(String userId)
    Find Category
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph
    getByGUID(String userId, String guid)
    Get a Graph.
    List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category>
    getCategories(String userId, String graphGuid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)
    Find Category for a graph
    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
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph
    getGraph(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)
    Get graph for a particular node guid
    org.odpi.openmetadata.viewservices.glossaryauthor.properties.GraphStatistics
    getGraphStatistics(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter)
    Get graphStats for a particular guid
    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.graph.Graph
    restore(String userId, String guid)
    Restore a soft-deleted Graph.
    org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph
    update(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph graph, boolean isReplace)
    Update a Graph.

  • Method Details

    • create

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

      The result is the Graph object

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

      The result is the requested Graph object

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

      The result is the updated Glossary object

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

      The result Void object

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

      The result is the restored Graph object

      Parameters:
      userId - userId under which the request is performed
      guid - guid of Graph object to be restored
      Returns:
      The restored Graph
      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.graph.Graph> 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.graph.Graph> 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
      Find graphs
      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 graphGuid, 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
      Find Category for a graph
      Parameters:
      userId - calling user
      graphGuid - graph id
      findRequest - nformation object for find calls. This include pageSize to limit the number of elements returned.
      Returns:
      Categories belonging to graph
      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

    • getGraph

      org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Graph getGraph(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get graph for a particular node guid
      Parameters:
      userId - calling user
      guid - the starting point of the query.
      nodeFilter - Set of node names to include in the query results. Null means include all entities found, irrespective of their type.
      relationshipFilter - Set of relationship names to include in the query results. Null means include all relationships found, irrespective of their type.
      asOfTime - Requests a historical query of the relationships for the entity. Null means return the present values.
      statusFilter - By default only active instances are returned. Specify ALL to see all instance in any status.
      Returns:
      A graph of nodeTypes.
      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

    • getGraphStatistics

      org.odpi.openmetadata.viewservices.glossaryauthor.properties.GraphStatistics getGraphStatistics(String userId, String guid, Date asOfTime, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.NodeType> nodeFilter, Set<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.RelationshipType> relationshipFilter, org.odpi.openmetadata.accessservices.subjectarea.properties.enums.StatusFilter statusFilter) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Get graphStats for a particular guid
      Parameters:
      userId - calling user
      guid - Guid for a node.
      asOfTime - Requests a historical query of the relationships for the entity. Null means return the present values.
      nodeFilter - Set of node names to include in the query results. Null means include all entities found, irrespective of their type.
      relationshipFilter - Set of relationship names to include in the query results. Null means include all relationships found, irrespective of their type.
      statusFilter - By default only active instances are returned. Specify ALL to see all instance in any status.
      Returns:
      A graph statistics of nodeTypes.
      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