Package org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceDomainInterface

public interface GovernanceDomainInterface
GovernanceDomainInterface sets up the governance domains that are part of an organization governance. Each governance domain describes a focus for governance. The governance domain typically focuses on a particular set of activity within the organization. There is often overlap in the resources (assets) that each domain governs. As a result, there is often linkage between the governance definitions from different governance domains.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDomainToSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID)
    Create a parent-child relationship between a governance domain set and a governance domain.
    String
    createGovernanceDomain(String userId, String setGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainProperties governanceDomainProperties)
    Create a new metadata element to represent a governance domain.
    String
    createGovernanceDomainSet(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainSetProperties governanceDomainSetProperties)
    Create a new metadata element to represent the root of a Governance Domain Set.
    String
    createStandardGovernanceDomains(String userId)
    Create a governance domain set called "EgeriaStandardDomains" containing governance domain definitions for the following governance domains.
    void
    deleteGovernanceDomain(String userId, String governanceDomainGUID)
    Remove the metadata element representing a Governance Domain.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement>
    findGovernanceDomains(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of Governance Domain metadata elements that contain the search string.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement>
    findGovernanceDomainSets(String userId, String searchString, int startFrom, int pageSize)
    Retrieve the list of governanceDomainSet metadata elements that contain the search string.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement
    getGovernanceDomainByGUID(String userId, String governanceDomainGUID)
    Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement
    getGovernanceDomainByIdentifier(String userId, int domainIdentifier)
    Retrieve the Governance Domain metadata element with the supplied domain identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement>
    getGovernanceDomains(String userId, int startFrom, int pageSize)
    Retrieve the list of Governance Domain metadata elements defined for the governance program.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement>
    getGovernanceDomainsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of Governance Domain metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement
    getGovernanceDomainSetByGUID(String userId, String governanceDomainSetGUID)
    Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement>
    getGovernanceDomainSetsByName(String userId, String name, int startFrom, int pageSize)
    Retrieve the list of governanceDomainSet metadata elements with a matching qualified or display name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement>
    getSetsForGovernanceDomain(String userId, String governanceDomainGUID, int startFrom, int pageSize)
    Return the list of governance domain sets that a governance domain belong.
    void
    removeDomainFromSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID)
    Remove a parent-child relationship between a governance domain set and a governance domain.
    void
    removeGovernanceDomainSet(String userId, String governanceDomainSetGUID)
    Remove the metadata element representing a governanceDomainSet.
    void
    updateGovernanceDomain(String userId, String governanceDomainGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainProperties governanceDomainProperties)
    Update the metadata element representing a Governance Domain.
    void
    updateGovernanceDomainSet(String userId, String governanceDomainSetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainSetProperties governanceDomainSetProperties)
    Update the metadata element representing a Governance Domain Set.

  • Method Details

    • createStandardGovernanceDomains

      String createStandardGovernanceDomains(String userId) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a governance domain set called "EgeriaStandardDomains" containing governance domain definitions for the following governance domains.
      • Unclassified - The governance domain is not specified - that is the definition applies to all domains - this is the default value for governance definitions within the governance program.
      • Data - The data (information) governance domain
      • Privacy - The data privacy governance domain
      • Security - The security governance domain.
      • IT Infrastructure - The IT infrastructure management governance domain.
      • Software Development - The software development lifecycle (SDLC) governance domain.
      • Corporate - The corporate governance domain.
      • Asset Management - The physical asset management governance domain.
      Parameters:
      userId - calling user
      Returns:
      unique identifier of the governance domain set
      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)

    • createGovernanceDomainSet

      String createGovernanceDomainSet(String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainSetProperties governanceDomainSetProperties) 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 metadata element to represent the root of a Governance Domain Set.
      Parameters:
      userId - calling user
      governanceDomainSetProperties - properties to store
      Returns:
      unique identifier of the new 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)

    • updateGovernanceDomainSet

      void updateGovernanceDomainSet(String userId, String governanceDomainSetGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainSetProperties governanceDomainSetProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a Governance Domain Set.
      Parameters:
      userId - calling user
      governanceDomainSetGUID - unique identifier of the metadata element to remove
      governanceDomainSetProperties - new properties for this 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)

    • removeGovernanceDomainSet

      void removeGovernanceDomainSet(String userId, String governanceDomainSetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a governanceDomainSet. The governance domains are not deleted.
      Parameters:
      userId - calling user
      governanceDomainSetGUID - unique identifier of the metadata element to remove
      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)

    • findGovernanceDomainSets

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement> findGovernanceDomainSets(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 governanceDomainSet 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)

    • getGovernanceDomainSetsByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement> getGovernanceDomainSetsByName(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 governanceDomainSet 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)

    • getGovernanceDomainSetByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement getGovernanceDomainSetByGUID(String userId, String governanceDomainSetGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      governanceDomainSetGUID - 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)

    • createGovernanceDomain

      String createGovernanceDomain(String userId, String setGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainProperties governanceDomainProperties) 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 metadata element to represent a governance domain.
      Parameters:
      userId - calling user
      setGUID - unique identifier of the set that this identifier belongs
      governanceDomainProperties - properties about the Governance Domain to store
      Returns:
      unique identifier of the new Governance Domain
      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)

    • updateGovernanceDomain

      void updateGovernanceDomain(String userId, String governanceDomainGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.governance.GovernanceDomainProperties governanceDomainProperties) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the metadata element representing a Governance Domain.
      Parameters:
      userId - calling user
      governanceDomainGUID - unique identifier of the metadata element to update
      governanceDomainProperties - new properties for the 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)

    • deleteGovernanceDomain

      void deleteGovernanceDomain(String userId, String governanceDomainGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove the metadata element representing a Governance Domain.
      Parameters:
      userId - calling user
      governanceDomainGUID - unique identifier of the metadata element to remove
      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)

    • addDomainToSet

      void addDomainToSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a parent-child relationship between a governance domain set and a governance domain.
      Parameters:
      userId - calling user
      governanceDomainSetGUID - unique identifier of the governance domain set
      governanceDomainGUID - unique identifier of the governance domain
      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)

    • removeDomainFromSet

      void removeDomainFromSet(String userId, String governanceDomainSetGUID, String governanceDomainGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Remove a parent-child relationship between a governance domain set and a governance domain.
      Parameters:
      userId - calling user
      governanceDomainSetGUID - unique identifier of the governance domain set
      governanceDomainGUID - unique identifier of the governance domain
      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)

    • getGovernanceDomains

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement> getGovernanceDomains(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 Governance Domain metadata elements defined for the governance program.
      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)

    • findGovernanceDomains

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement> findGovernanceDomains(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 Governance Domain 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)

    • getSetsForGovernanceDomain

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainSetElement> getSetsForGovernanceDomain(String userId, String governanceDomainGUID, 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 the list of governance domain sets that a governance domain belong.
      Parameters:
      userId - calling user
      governanceDomainGUID - unique identifier of the governance domain to query
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of metadata elements describing the sets associated with the requested governanceDomainSet
      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)

    • getGovernanceDomainsByName

      List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement> getGovernanceDomainsByName(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 Governance Domain 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)

    • getGovernanceDomainByGUID

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement getGovernanceDomainByGUID(String userId, String governanceDomainGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the Governance Domain metadata element with the supplied unique identifier assigned when the domain description was stored in the metadata repository.
      Parameters:
      userId - calling user
      governanceDomainGUID - unique identifier of the requested metadata element
      Returns:
      requested 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)

    • getGovernanceDomainByIdentifier

      org.odpi.openmetadata.frameworks.openmetadata.metadataelements.GovernanceDomainElement getGovernanceDomainByIdentifier(String userId, int domainIdentifier) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the Governance Domain metadata element with the supplied domain identifier.
      Parameters:
      userId - calling user
      domainIdentifier - identifier used to identify the domain
      Returns:
      requested 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)