Package org.odpi.openmetadata.accessservices.digitalservice.api

Interface DigitalServicesInterface

public interface DigitalServicesInterface
The DigitalServicesInterface supports the management of digital services. The DigitalRolesInterface supports the appointment of digital service managers. The BusinessCapabilityManagement associates business capabilities with the digital services.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID)
    Remove the dependency link between two digital services.
    void
    clearDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID)
    Remove the dependency link between two digital services.
    String
    createDigitalService(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceProperties properties, org.odpi.openmetadata.frameworks.openmetadata.enums.DigitalServiceStatus initialStatus)
    Create a new digital service.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement>
    findDigitalServices(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getDependentDigitalServices(String userId, String digitalServiceGUID, int startFrom, int pageSize)
    Return information about the dependent digital services.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement
    getDigitalServiceByGUID(String userId, String digitalServiceGUID)
    Retrieve the digital service metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getDigitalServiceDependencies(String userId, String digitalServiceGUID, int startFrom, int pageSize)
    Return information about the digital services that this digital service is dependent on.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement>
    getDigitalServices(String userId, int startFrom, int pageSize)
    Retrieve the list of digital services.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement>
    getDigitalServicesByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getSupportedBusinessCapabilities(String userId, String digitalServiceGUID, int startFrom, int pageSize)
    Return information about the business capabilities supported by a digital service.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement>
    getSupportedDigitalProducts(String userId, String digitalServiceGUID, int startFrom, int pageSize)
    Return information about the digital products supported by a digital service.
    void
    removeDigitalService(String userId, String digitalServiceGUID)
    Delete a specific digital service.
    void
    setDigitalServiceStatus(String userId, String digitalServiceGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.DigitalServiceStatus newStatus)
    Update the status of a digital service
    void
    setupDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceDependencyProperties properties)
    Create a link to show that a digital service supports the requirements of another digital service.
    void
    setupDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceDependencyProperties properties)
    Create a link to show that an organization has responsibility in operating a digital service.
    void
    updateDigitalService(String userId, String digitalServiceGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceProperties properties)
    Update an existing digital service.

  • Method Details

    • createDigitalService

      String createDigitalService(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceProperties properties, org.odpi.openmetadata.frameworks.openmetadata.enums.DigitalServiceStatus initialStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a new digital service.
      Parameters:
      userId - calling user
      properties - properties of the digital service
      initialStatus - what is the initial status for the digital service - default value is DRAFT
      Returns:
      unique identifier of the digital service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the properties is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the metadata service
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • updateDigitalService

      void updateDigitalService(String userId, String digitalServiceGUID, boolean isMergeUpdate, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update an existing digital service.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service to update
      isMergeUpdate - are unspecified properties unchanged (true) or removed?
      properties - properties to update
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the properties is null or invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • setDigitalServiceStatus

      void setDigitalServiceStatus(String userId, String digitalServiceGUID, org.odpi.openmetadata.frameworks.openmetadata.enums.DigitalServiceStatus newStatus) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the status of a digital service
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier
      newStatus - new status
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid, status or userId is null; guid is not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • removeDigitalService

      void removeDigitalService(String userId, String digitalServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Delete a specific digital service.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service to remove
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - guid is null or not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • setupDigitalServiceDependency

      void setupDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceDependencyProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link to show that a digital service supports the requirements of another digital service. If the link already exists the properties are updated.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service
      dependentDigitalServiceGUID - unique identifier of the supporting digital service
      properties - description of how the supporting digital service provides support
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • clearDigitalServiceDependency

      void clearDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the dependency link between two digital services.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service
      dependentDigitalServiceGUID - unique identifier of the supporting digital service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • setupDigitalServiceOperator

      void setupDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalServiceDependencyProperties properties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a link to show that an organization has responsibility in operating a digital service. If the link already exists the properties are updated.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service
      organizationGUID - unique identifier of the organization operating the digital service
      properties - description of the scope of responsibilities that the organization has in the operation of the digital service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • clearDigitalServiceOperator

      void clearDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the dependency link between two digital services.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the digital service
      organizationGUID - unique identifier of the organization operating the digital service
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the guids is null or not known
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • findDigitalServices

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement> findDigitalServices(String userId, String searchString, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      userId - calling user
      searchString - string to find in the properties
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDigitalServicesByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement> getDigitalServicesByName(String userId, String name, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      userId - calling user
      name - name to search for
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDigitalServices

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement> getDigitalServices(String userId, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the list of digital services.
      Parameters:
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of matching metadata elements
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • getDependentDigitalServices

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getDependentDigitalServices(String userId, String digitalServiceGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the dependent digital services.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier for the digital service
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getDigitalServiceDependencies

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getDigitalServiceDependencies(String userId, String digitalServiceGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the digital services that this digital service is dependent on.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier for the digital service
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getSupportedBusinessCapabilities

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getSupportedBusinessCapabilities(String userId, String digitalServiceGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the business capabilities supported by a digital service.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier for the digital service
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getSupportedDigitalProducts

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.RelatedElement> getSupportedDigitalProducts(String userId, String digitalServiceGUID, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Return information about the digital products supported by a digital service.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier for the digital service
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      list of matching actor profiles (hopefully only one)
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - name or userId is null
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing property server
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - security access problem

    • getDigitalServiceByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.DigitalServiceElement getDigitalServiceByGUID(String userId, String digitalServiceGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the digital service metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      digitalServiceGUID - unique identifier of the requested metadata element
      Returns:
      matching metadata element
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)