Package org.odpi.openmetadata.accessservices.communityprofile.server

Class RelatedElementRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.server.RelatedElementRESTServices

public class RelatedElementRESTServices
extends Object

RelatedElementRESTServices support requests about common Referenceable relationships. It is the server side for the RelatedElementsManagementInterface.

Constructor Summary

Constructors

Constructor	Description
RelatedElementRESTServices()

Method Summary

Modifier and Type	Method	Description
VoidResponse	clearAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, ExternalSourceRequestBody requestBody)	Remove an "AssignmentScope" relationship between two referenceables.
VoidResponse	clearMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, ExternalSourceRequestBody requestBody)	Remove a "MoreInformation" relationship between two referenceables.
VoidResponse	clearResource(String serverName, String userId, String elementGUID, String resourceGUID, ExternalSourceRequestBody requestBody)	Remove a "ResourceList" relationship between two referenceables.
VoidResponse	clearStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, ExternalSourceRequestBody requestBody)	Remove a "Stakeholder" relationship between two referenceables.
RelatedElementListResponse	getAssignedActors(String serverName, String userId, String scopeGUID, int startFrom, int pageSize)	Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
RelatedElementListResponse	getAssignedScopes(String serverName, String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
RelatedElementListResponse	getDescriptiveElements(String serverName, String userId, String detailGUID, int startFrom, int pageSize)	Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
RelatedElementListResponse	getMoreInformation(String serverName, String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
RelatedElementListResponse	getResourceList(String serverName, String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
RelatedElementListResponse	getStakeholderCommissionedElements(String serverName, String userId, String stakeholderGUID, int startFrom, int pageSize)	Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
RelatedElementListResponse	getStakeholders(String serverName, String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
RelatedElementListResponse	getSupportedByResource(String serverName, String userId, String resourceGUID, int startFrom, int pageSize)	Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
VoidResponse	setupAssignmentScope(String serverName, String userId, String elementGUID, String scopeGUID, RelationshipRequestBody requestBody)	Create an "AssignmentScope" relationship between an element and its scope.
VoidResponse	setupMoreInformation(String serverName, String userId, String elementGUID, String detailGUID, RelationshipRequestBody requestBody)	Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
VoidResponse	setupResource(String serverName, String userId, String elementGUID, String resourceGUID, RelationshipRequestBody requestBody)	Create a "ResourceList" relationship between a consuming element and an element that represents resources.
VoidResponse	setupStakeholder(String serverName, String userId, String elementGUID, String stakeholderGUID, RelationshipRequestBody requestBody)	Create a "Stakeholder" relationship between an element and its stakeholder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RelatedElementRESTServices

public RelatedElementRESTServices()

Method Detail

setupMoreInformation

public VoidResponse setupMoreInformation(String serverName,
                                         String userId,
                                         String elementGUID,
                                         String detailGUID,
                                         RelationshipRequestBody requestBody)

Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element that is descriptive

detailGUID - unique identifier of the element that provides the detail

requestBody - relationship properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearMoreInformation

public VoidResponse clearMoreInformation(String serverName,
                                         String userId,
                                         String elementGUID,
                                         String detailGUID,
                                         ExternalSourceRequestBody requestBody)

Remove a "MoreInformation" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element that is descriptive

detailGUID - unique identifier of the element that provides the detail

requestBody - external source identifiers

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getMoreInformation

public RelatedElementListResponse getMoreInformation(String serverName,
                                                     String userId,
                                                     String elementGUID,
                                                     int startFrom,
                                                     int pageSize)

Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element that is descriptive

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getDescriptiveElements

public RelatedElementListResponse getDescriptiveElements(String serverName,
                                                         String userId,
                                                         String detailGUID,
                                                         int startFrom,
                                                         int pageSize)

Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

detailGUID - unique identifier of the element that provides the detail

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupStakeholder

public VoidResponse setupStakeholder(String serverName,
                                     String userId,
                                     String elementGUID,
                                     String stakeholderGUID,
                                     RelationshipRequestBody requestBody)

Create a "Stakeholder" relationship between an element and its stakeholder.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

stakeholderGUID - unique identifier of the stakeholder

requestBody - relationship properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearStakeholder

public VoidResponse clearStakeholder(String serverName,
                                     String userId,
                                     String elementGUID,
                                     String stakeholderGUID,
                                     ExternalSourceRequestBody requestBody)

Remove a "Stakeholder" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

stakeholderGUID - unique identifier of the stakeholder

requestBody - external source identifiers

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getStakeholders

public RelatedElementListResponse getStakeholders(String serverName,
                                                  String userId,
                                                  String elementGUID,
                                                  int startFrom,
                                                  int pageSize)

Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getStakeholderCommissionedElements

public RelatedElementListResponse getStakeholderCommissionedElements(String serverName,
                                                                     String userId,
                                                                     String stakeholderGUID,
                                                                     int startFrom,
                                                                     int pageSize)

Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

stakeholderGUID - unique identifier of the stakeholder

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupAssignmentScope

public VoidResponse setupAssignmentScope(String serverName,
                                         String userId,
                                         String elementGUID,
                                         String scopeGUID,
                                         RelationshipRequestBody requestBody)

Create an "AssignmentScope" relationship between an element and its scope.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

scopeGUID - unique identifier of the scope

requestBody - relationship properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearAssignmentScope

public VoidResponse clearAssignmentScope(String serverName,
                                         String userId,
                                         String elementGUID,
                                         String scopeGUID,
                                         ExternalSourceRequestBody requestBody)

Remove an "AssignmentScope" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

scopeGUID - unique identifier of the scope

requestBody - external source identifiers

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getAssignedScopes

public RelatedElementListResponse getAssignedScopes(String serverName,
                                                    String userId,
                                                    String elementGUID,
                                                    int startFrom,
                                                    int pageSize)

Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getAssignedActors

public RelatedElementListResponse getAssignedActors(String serverName,
                                                    String userId,
                                                    String scopeGUID,
                                                    int startFrom,
                                                    int pageSize)

Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

scopeGUID - unique identifier of the scope

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupResource

public VoidResponse setupResource(String serverName,
                                  String userId,
                                  String elementGUID,
                                  String resourceGUID,
                                  RelationshipRequestBody requestBody)

Create a "ResourceList" relationship between a consuming element and an element that represents resources.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

resourceGUID - unique identifier of the resource

requestBody - relationship properties

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearResource

public VoidResponse clearResource(String serverName,
                                  String userId,
                                  String elementGUID,
                                  String resourceGUID,
                                  ExternalSourceRequestBody requestBody)

Remove a "ResourceList" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

resourceGUID - unique identifier of the resource

requestBody - external source identifiers

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getResourceList

public RelatedElementListResponse getResourceList(String serverName,
                                                  String userId,
                                                  String elementGUID,
                                                  int startFrom,
                                                  int pageSize)

Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

elementGUID - unique identifier of the element

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getSupportedByResource

public RelatedElementListResponse getSupportedByResource(String serverName,
                                                         String userId,
                                                         String resourceGUID,
                                                         int startFrom,
                                                         int pageSize)

Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.

Parameters:

serverName - name of the service to route the request to.

userId - calling user

resourceGUID - unique identifier of the resource

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)