org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaGraph

All Known Implementing Classes:

SubjectAreaGraphImpl

public interface SubjectAreaGraph

The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for graph

Method Summary

Modifier and Type	Method and Description
Graph	getGraph(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<LineType> lineFilter, StatusFilter statusFilter, Integer level) Get the graph of nodes and Lines radiating out from a node.

Method Detail

getGraph

Graph getGraph(String userId,
               String guid,
               Date asOfTime,
               Set<NodeType> nodeFilter,
               Set<LineType> lineFilter,
               StatusFilter statusFilter,
               Integer level)
        throws UserNotAuthorizedException,
               InvalidParameterException,
               FunctionNotSupportedException,
               MetadataServerUncontactableException,
               UnexpectedResponseException

Get the graph of nodes and Lines radiating out from a node. The results are scoped by types of Lines, types of nodes and classifications as well as level.

Parameters:

userId - userId under which the request is performed

guid - the starting point of the query.

nodeFilter - Set of the names of the nodes to include in the query results. Null means include all nodes found, irrespective of their type.

lineFilter - Set of names of Lines to include in the query results. Null means include all Lines found, irrespective of their type.

statusFilter - By default only active instances are returned. Specify ALL to see all instance in any status.

asOfTime - Requests a historical query of the Lines for the node. Null means return the present values.

level - the number of the Lines (relationships) out from the starting node that the query will traverse to gather results. If not specified then it defaults to 3.

Returns:

A graph of nodes. Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server