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 and Description
String	createGovernanceDomain(String userId, String setGUID, GovernanceDomainProperties governanceDomainProperties) Create a new metadata element to represent a governance domain.
String	createGovernanceDomainSet(String userId, 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<GovernanceDomainElement>	findGovernanceDomains(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of Governance Domain metadata elements that contain the search string.
List<GovernanceDomainSetElement>	findGovernanceDomainSets(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of governanceDomainSet metadata elements that contain the search string.
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.
GovernanceDomainElement	getGovernanceDomainByIdentifier(String userId, int domainIdentifier) Retrieve the Governance Domain metadata element with the supplied domain identifier.
List<GovernanceDomainElement>	getGovernanceDomains(String userId, int startFrom, int pageSize) Retrieve the list of Governance Domain metadata elements defined for the governance program.
List<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.
GovernanceDomainSetElement	getGovernanceDomainSetByGUID(String userId, String governanceDomainSetGUID) Retrieve the governanceDomainSet metadata element with the supplied unique identifier.
List<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<GovernanceDomainSetElement>	getSetsForGovernanceDomain(String userId, String governanceDomainGUID, int startFrom, int pageSize) Return the list of governance domain sets that a governance domain belong.
void	removeGovernanceDomainSet(String userId, String governanceDomainSetGUID) Remove the metadata element representing a governanceDomainSet.
void	updateGovernanceDomain(String userId, String governanceDomainGUID, GovernanceDomainProperties governanceDomainProperties) Update the metadata element representing a Governance Domain.
void	updateGovernanceDomainSet(String userId, String governanceDomainSetGUID, GovernanceDomainSetProperties governanceDomainSetProperties) Update the metadata element representing a Governance Domain Set.

Method Detail

createStandardGovernanceDomains

String createStandardGovernanceDomains(String userId)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       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.
• Other - The governance domain is locally defined.

Parameters:

userId - calling user

Returns:

unique identifier of the governance domain set

Throws:

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)

createGovernanceDomainSet

String createGovernanceDomainSet(String userId,
                                 GovernanceDomainSetProperties governanceDomainSetProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 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:

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)

updateGovernanceDomainSet

void updateGovernanceDomainSet(String userId,
                               String governanceDomainSetGUID,
                               GovernanceDomainSetProperties governanceDomainSetProperties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               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:

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)

removeGovernanceDomainSet

void removeGovernanceDomainSet(String userId,
                               String governanceDomainSetGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               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:

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)

findGovernanceDomainSets

List<GovernanceDomainSetElement> findGovernanceDomainSets(String userId,
                                                          String searchString,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          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:

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)

getGovernanceDomainSetsByName

List<GovernanceDomainSetElement> getGovernanceDomainSetsByName(String userId,
                                                               String name,
                                                               int startFrom,
                                                               int pageSize)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               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:

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)

getGovernanceDomainSetByGUID

GovernanceDomainSetElement getGovernanceDomainSetByGUID(String userId,
                                                        String governanceDomainSetGUID)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        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:

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)

createGovernanceDomain

String createGovernanceDomain(String userId,
                              String setGUID,
                              GovernanceDomainProperties governanceDomainProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              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:

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)

updateGovernanceDomain

void updateGovernanceDomain(String userId,
                            String governanceDomainGUID,
                            GovernanceDomainProperties governanceDomainProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            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:

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)

deleteGovernanceDomain

void deleteGovernanceDomain(String userId,
                            String governanceDomainGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Remove the metadata element representing a Governance Domain.

Parameters:

userId - calling user

governanceDomainGUID - unique identifier of the metadata element to remove

Throws:

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)

getGovernanceDomains

List<GovernanceDomainElement> getGovernanceDomains(String userId,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of Governance Domain metadata elements defined for the governance program. The search string is treated as a regular expression.

Parameters:

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

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)

findGovernanceDomains

List<GovernanceDomainElement> findGovernanceDomains(String userId,
                                                    String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    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:

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)

getSetsForGovernanceDomain

List<GovernanceDomainSetElement> getSetsForGovernanceDomain(String userId,
                                                            String governanceDomainGUID,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            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:

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)

getGovernanceDomainsByName

List<GovernanceDomainElement> getGovernanceDomainsByName(String userId,
                                                         String name,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         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:

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)

getGovernanceDomainByGUID

GovernanceDomainElement getGovernanceDomainByGUID(String userId,
                                                  String governanceDomainGUID)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  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:

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)

getGovernanceDomainByIdentifier

GovernanceDomainElement getGovernanceDomainByIdentifier(String userId,
                                                        int domainIdentifier)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        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:

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)