Interface SubjectAreaNodeClient<E extends Node>
- Type Parameters:
E
- inherited fromNode
type Interface for Subject Area client node operations
- All Superinterfaces:
SubjectAreaClient<E>
- All Known Implementing Classes:
AbstractSubjectAreaNode
,SubjectAreaCategoryClient
,SubjectAreaGlossaryClient
,SubjectAreaProjectClient
,SubjectAreaTermClient
-
Field Summary
Fields inherited from interface org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaClient
EMPTY_FIND_REQUEST
-
Method Summary
Modifier and TypeMethodDescriptiondefault List<Relationship>
getAllRelationships
(String userId, String guid) Request to search all relationships for current node.getRelationships
(String userId, String guid, FindRequest findRequest) Request to search relationships for current node.getRelationships
(String userId, String guid, FindRequest findRequest, Integer maximumPageSizeOnRestCall) Request to search relationships for current node.
-
Method Details
-
getRelationships
List<Relationship> getRelationships(String userId, String guid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, 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:
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.
-
getRelationships
List<Relationship> getRelationships(String userId, String guid, FindRequest findRequest, Integer maximumPageSizeOnRestCall) throws InvalidParameterException, PropertyServerException, 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:
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.
-
getAllRelationships
default List<Relationship> getAllRelationships(String userId, String guid) throws InvalidParameterException, PropertyServerException, 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:
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.
-