Package org.odpi.openmetadata.accessservices.assetowner.server

Class RelatedElementRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.assetowner.server.RelatedElementRESTServices
public class RelatedElementRESTServices extends Object
RelatedElementRESTServices support requests about common Referenceable relationships. It is the server side for the RelatedElementsManagementInterface.

  • Constructor Details

    • RelatedElementRESTServices

      public RelatedElementRESTServices()

  • Method Details

    • 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 RelatedElementsResponse 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 RelatedElementsResponse 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 RelatedElementsResponse 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 RelatedElementsResponse 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)

    • 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 RelatedElementsResponse 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 RelatedElementsResponse 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)

    • setupCatalogTemplate

      public VoidResponse setupCatalogTemplate(String serverName, String userId, String elementGUID, String templateGUID, RelationshipRequestBody requestBody)
      Create a "CatalogTemplate" relationship between a consuming element and a template element.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      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)

    • clearCatalogTemplate

      public VoidResponse clearCatalogTemplate(String serverName, String userId, String elementGUID, String templateGUID, ExternalSourceRequestBody requestBody)
      Remove a "CatalogTemplate" relationship between two referenceables.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      elementGUID - unique identifier of the element
      templateGUID - unique identifier of the template
      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)

    • getCatalogTemplateList

      public RelatedElementsResponse getCatalogTemplateList(String serverName, String userId, String elementGUID, int startFrom, int pageSize)
      Retrieve the list of templates assigned to an element via the "CatalogTemplate" relationship.
      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)

    • getSupportedByTemplate

      public RelatedElementsResponse getSupportedByTemplate(String serverName, String userId, String templateGUID, int startFrom, int pageSize)
      Retrieve the list of elements assigned to a template via the "CatalogTemplate" relationship.
      Parameters:
      serverName - name of the service to route the request to.
      userId - calling user
      templateGUID - unique identifier of the template
      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)