Package org.odpi.openmetadata.viewservices.digitalbusiness.server

Class DigitalBusinessRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.digitalbusiness.server.DigitalBusinessRESTServices
public class DigitalBusinessRESTServices extends TokenController
The DigitalBusinessRESTServices provides the server-side implementation of the Digital Business Open Metadata View Service (OMVS). This interface provides access to business capabilities. These are collections so Collection Manager OMVS provides the definition of the business capability element and this service handles the specialized relationships and classification.

  • Constructor Details

    • DigitalBusinessRESTServices

      public DigitalBusinessRESTServices()
      Default constructor

  • Method Details

    • linkBusinessCapabilityDependency

      public VoidResponse linkBusinessCapabilityDependency(String serverName, String businessCapabilityGUID, String supportingBusinessCapabilityGUID, NewRelationshipRequestBody requestBody)
      Link dependent business capabilities.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability that is dependent on another
      supportingBusinessCapabilityGUID - unique identifier of the business capability that is supporting
      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.

    • detachBusinessCapabilityDependency

      public VoidResponse detachBusinessCapabilityDependency(String serverName, String businessCapabilityGUID, String supportingBusinessCapabilityGUID, DeleteRelationshipRequestBody requestBody)
      Detach dependent business capabilities.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability that is dependent on another
      supportingBusinessCapabilityGUID - unique identifier of the business capability that is supporting
      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.

    • linkDigitalSupport

      public VoidResponse linkDigitalSupport(String serverName, String businessCapabilityGUID, String elementGUID, NewRelationshipRequestBody requestBody)
      Attach a business capability to an element that provides digital support.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability
      elementGUID - unique identifier of the element
      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.

    • detachDigitalSupport

      public VoidResponse detachDigitalSupport(String serverName, String businessCapabilityGUID, String elementGUID, DeleteRelationshipRequestBody requestBody)
      Detach a business capability from an element that provides digital support.
      Parameters:
      serverName - name of called server
      businessCapabilityGUID - unique identifier of the business capability
      elementGUID - unique identifier of the element
      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.

    • setBusinessSignificant

      public VoidResponse setBusinessSignificant(String serverName, String elementGUID, NewClassificationRequestBody requestBody)
      Classify an element to indicate that it is significant to a particular business capability.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • clearBusinessSignificance

      public VoidResponse clearBusinessSignificance(String serverName, String elementGUID, DeleteClassificationRequestBody requestBody)
      Remove the business significant classification from the element.
      Parameters:
      serverName - name of the server instance to connect to
      elementGUID - unique identifier of the metadata element to update
      requestBody - properties for classification request
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setAgreementAsDataSharingAgreement

      public VoidResponse setAgreementAsDataSharingAgreement(String serverName, String agreementGUID, NewClassificationRequestBody requestBody)
      Classify an agreement to say that it governs the sharing of data.
      Parameters:
      serverName - name of the server to route the request to
      agreementGUID - unique identifier of the agreement
      requestBody - properties for the classification
      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)

    • clearAgreementAsDataSharingAgreement

      public VoidResponse clearAgreementAsDataSharingAgreement(String serverName, String agreementGUID, DeleteClassificationRequestBody requestBody)
      Remove the data sharing agreement designation from an agreement.
      Parameters:
      serverName - name of the server to route the request to
      agreementGUID - unique identifier of the agreement
      requestBody - options for the request
      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)