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
Graph	create(String userId, Graph graph)	Create a Graph.
void	delete(String userId, String guid)	Delete a Graph.
List<Graph>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Find graphs
List<Graph>	findAll(String userId)	Find Category
Graph	getByGUID(String userId, String guid)	Get a Graph.
List<Category>	getCategories(String userId, String graphGuid, FindRequest findRequest)	Find Category for a graph
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
OMAGServerConfig	getConfig(String userId)	Get config for server
ViewServiceConfig	getGlossaryAuthViewServiceConfig(String userId)	Get service config for a particular view Service
Graph	getGraph(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<RelationshipType> relationshipFilter, StatusFilter statusFilter)	Get graph for a particular node guid
GraphStatistics	getGraphStatistics(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<RelationshipType> relationshipFilter, StatusFilter statusFilter)	Get graphStats for a particular guid
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
Graph	restore(String userId, String guid)	Restore a soft-deleted Graph.
Graph	update(String userId, String guid, Graph graph, boolean isReplace)	Update a Graph.

Method Detail

create

Graph create(String userId,
             Graph graph)
      throws PropertyServerException,
             UserNotAuthorizedException,
             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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getByGUID

Graph getByGUID(String userId,
                String guid)
         throws PropertyServerException,
                UserNotAuthorizedException,
                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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

update

Graph update(String userId,
             String guid,
             Graph graph,
             boolean isReplace)
      throws PropertyServerException,
             InvalidParameterException,
             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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

delete

void delete(String userId,
            String guid)
     throws 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:

PropertyServerException - something went wrong with the REST call stack.

restore

Graph restore(String userId,
              String guid)
       throws PropertyServerException,
              UserNotAuthorizedException,
              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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getCategoryChildren

List<Category> getCategoryChildren(String userId,
                                   String parentGuid,
                                   FindRequest findRequest,
                                   boolean exactValue,
                                   boolean ignoreCase)
                            throws PropertyServerException,
                                   UserNotAuthorizedException,
                                   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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

findAll

List<Graph> findAll(String userId)
             throws PropertyServerException,
                    UserNotAuthorizedException,
                    InvalidParameterException

Find Category

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

find

List<Graph> find(String userId,
                 FindRequest findRequest,
                 boolean exactValue,
                 boolean ignoreCase)
          throws PropertyServerException,
                 UserNotAuthorizedException,
                 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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getCategories

List<Category> getCategories(String userId,
                             String graphGuid,
                             FindRequest findRequest)
                      throws InvalidParameterException,
                             PropertyServerException,
                             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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getConfig

OMAGServerConfig getConfig(String userId)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Get config for server

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getViewServiceConfigs

List<ViewServiceConfig> getViewServiceConfigs(String userId)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Get list of view service config on the server

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getGlossaryAuthViewServiceConfig

ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId)
                                            throws InvalidParameterException,
                                                   PropertyServerException,
                                                   UserNotAuthorizedException

Get service config for a particular view Service

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getGraph

Graph getGraph(String userId,
               String guid,
               Date asOfTime,
               Set<NodeType> nodeFilter,
               Set<RelationshipType> relationshipFilter,
               StatusFilter statusFilter)
        throws InvalidParameterException,
               PropertyServerException,
               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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid

getGraphStatistics

GraphStatistics getGraphStatistics(String userId,
                                   String guid,
                                   Date asOfTime,
                                   Set<NodeType> nodeFilter,
                                   Set<RelationshipType> relationshipFilter,
                                   StatusFilter statusFilter)
                            throws InvalidParameterException,
                                   PropertyServerException,
                                   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:

PropertyServerException - something went wrong with the REST call stack.

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid