Interface SubjectAreaGraph
- All Known Implementing Classes:
SubjectAreaGraphClient
public interface SubjectAreaGraph
-
Method Summary
Modifier and TypeMethodDescriptiondefault Graph
getGraph
(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<RelationshipType> relationshipFilter, StatusFilter statusFilter, int level) Get the graph of nodes and relationships radiating out from a node.getGraph
(String userId, String guid, NeighborhoodHistoricalFindRequest request) Get the graph of nodes and relationships radiating out from a node.
-
Method Details
-
getGraph
default Graph getGraph(String userId, String guid, Date asOfTime, Set<NodeType> nodeFilter, Set<RelationshipType> relationshipFilter, StatusFilter statusFilter, int level) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get the graph of nodes and relationships radiating out from a node.The results are scoped by types of relationships, types of nodes and classifications as well as level.
- Parameters:
userId
- userId under which the request is performedguid
- 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.relationshipFilter
- Set of names of relationships 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.asOfTime
- Requests a historical query of the relationships for the node. Null means return the present values.level
- the number of the relationships (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.
- 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, NeighborhoodHistoricalFindRequest request) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get the graph of nodes and relationships radiating out from a node.The results are scoped by types of relationships, types of nodes and classifications as well as level.
- Parameters:
userId
- userId under which the request is performedguid
- the starting point of the query.request
-NeighborhoodHistoricalFindRequest
- Returns:
- A graph of nodes.
- 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
-