Package org.odpi.openmetadata.viewservices.productmanager.server

Class ProductManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.productmanager.server.ProductManagerRESTServices
public class ProductManagerRESTServices extends TokenController
The ProductManagerRESTServices provides the server-side implementation of the Product Manager Open Metadata View Service (OMVS). This interface provides access to digital products and digital product families.

  • Constructor Details

    • ProductManagerRESTServices

      public ProductManagerRESTServices()
      Default constructor

  • Method Details

    • linkDigitalProductDependency

      public GUIDResponse linkDigitalProductDependency(String serverName, String consumerDigitalProductGUID, String consumedDigitalProductGUID, NewRelationshipRequestBody requestBody)
      Link two dependent products.
      Parameters:
      serverName - name of called server
      consumerDigitalProductGUID - unique identifier of the digital product that has the dependency.
      consumedDigitalProductGUID - unique identifier of the digital product that it is using.
      requestBody - description of the relationship.
      Returns:
      unique identifier of the new relationship or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateDigitalProductDependency

      public VoidResponse updateDigitalProductDependency(String serverName, String digitalProductDependencyRelationshipGUID, UpdateRelationshipRequestBody requestBody)
      Update the properties of a digital product dependency relationship.
      Parameters:
      serverName - name of the server to route the request to
      digitalProductDependencyRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachDigitalProductDependency

      public VoidResponse detachDigitalProductDependency(String serverName, String digitalProductDependencyRelationshipGUID, DeleteRelationshipRequestBody requestBody)
      Remove a digital product dependency relationship.
      Parameters:
      serverName - name of the server to route the request to
      digitalProductDependencyRelationshipGUID - unique identifier of the relationship
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • linkProductManager

      public VoidResponse linkProductManager(String serverName, String digitalProductGUID, String digitalProductManagerRoleGUID, NewRelationshipRequestBody requestBody)
      Attach a product manager to a digital product.
      Parameters:
      serverName - name of called server
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerRoleGUID - unique identifier of the product manager role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachProductManager

      public VoidResponse detachProductManager(String serverName, String digitalProductGUID, String digitalProductManagerRoleGUID, DeleteRelationshipRequestBody requestBody)
      Detach a product manager from a digital product.
      Parameters:
      serverName - name of called server
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerRoleGUID - unique identifier of the product manager role
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDigitalProductDependency

      public VoidResponse detachDigitalProductDependency(String serverName, String consumerDigitalProductGUID, String consumedDigitalProductGUID, DeleteRelationshipRequestBody requestBody)
      Unlink dependent products.
      Parameters:
      serverName - name of called server
      consumerDigitalProductGUID - unique identifier of the digital product that has the dependency.
      consumedDigitalProductGUID - unique identifier of the digital product that it is using.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request. This is a multi-link relationship, so this request removes every digital product dependency relationship between the two elements. Use the request that takes the relationship's own unique identifier to remove just one of them.