Package org.odpi.openmetadata.accessservices.subjectarea.client

Interface SubjectAreaNodeClient<E extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Node>

Type Parameters:

E - inherited from Node type Interface for Subject Area client node operations

All Superinterfaces:

SubjectAreaClient<E>

All Known Implementing Classes:

AbstractSubjectAreaNode, SubjectAreaCategoryClient, SubjectAreaGlossaryClient, SubjectAreaProjectClient, SubjectAreaTermClient

public interface SubjectAreaNodeClient<E extends org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Node>
extends SubjectAreaClient<E>

Field Summary

Fields inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

EMPTY_FIND_REQUEST

Method Summary

Modifier and Type	Method	Description
default List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>	getAllRelationships(String userId, String guid)	Request to search all relationships for current node.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>	getRelationships(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest)	Request to search relationships for current node.
List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship>	getRelationships(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest, Integer maximumPageSizeOnRestCall)	Request to search relationships for current node.

Methods inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient

create, delete, find, find, find, findAll, findAll, getByGUID, replace, restore, update, update

Method Details

getRelationships

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getRelationships(String userId,
 String guid,
 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

Request to search relationships for current node.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

findRequest - information object for find calls.

Returns:

list relationships relevant in the findRequest information.

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.

getRelationships

List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getRelationships(String userId,
 String guid,
 org.odpi.openmetadata.accessservices.subjectarea.properties.objects.common.FindRequest findRequest,
 Integer maximumPageSizeOnRestCall)
                                                                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Request to search relationships for current node.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

findRequest - information object for find calls.

maximumPageSizeOnRestCall - maximum page size to use on rest calls.

Returns:

list relationships relevant in the findRequest information.

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.

getAllRelationships

default List<org.odpi.openmetadata.accessservices.subjectarea.properties.objects.graph.Relationship> getAllRelationships(String userId,
 String guid)
                                                                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Request to search all relationships for current node.

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

Returns:

list all relationships.

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.