org.odpi.openmetadata.accessservices.governanceprogram.api

Interface GovernanceMetricsInterface

public interface GovernanceMetricsInterface

The GovernanceMetricsInterface supports the definition of the metrics that measure the success of the governance program. Typically a metric is associated with a governance definition.

Method Summary

Modifier and Type	Method and Description
void	clearGovernanceDefinitionMetric(String userId, String metricGUID, String governanceDefinitionGUID) Remove the link between a governance metric and a governance definition.
String	createGovernanceMetric(String userId, GovernanceMetricProperties metricProperties) Create a new governance metric.
void	deleteGovernanceMetric(String userId, String metricGUID) Delete a specific governance metric.
List<GovernanceMetricElement>	findGovernanceMetrics(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of governance metrics for this search string.
GovernanceMetricElement	getGovernanceMetricByGUID(String userId, String metricGUID) Return information about a specific governance metric.
void	setupGovernanceDefinitionMetric(String userId, String metricGUID, String governanceDefinitionGUID, String rationale) Create a link to show that a governance metric supports the requirements of one of the governance policies.
void	updateGovernanceMetric(String userId, String metricGUID, boolean isMergeUpdate, GovernanceMetricProperties metricProperties) Update an existing governance metric.

Method Detail

createGovernanceMetric

String createGovernanceMetric(String userId,
                              GovernanceMetricProperties metricProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Create a new governance metric.

Parameters:

userId - calling user

metricProperties - properties of the metric

Returns:

unique identifier of the metric

Throws:

InvalidParameterException - typeName, documentIdentifier or userId is null; documentIdentifier is not unique; typeName is not valid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateGovernanceMetric

void updateGovernanceMetric(String userId,
                            String metricGUID,
                            boolean isMergeUpdate,
                            GovernanceMetricProperties metricProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update an existing governance metric.

Parameters:

userId - calling user

metricGUID - unique identifier of the metric to update

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

metricProperties - properties to update

Throws:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteGovernanceMetric

void deleteGovernanceMetric(String userId,
                            String metricGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Delete a specific governance metric.

Parameters:

userId - calling user

metricGUID - unique identifier of the metric to remove

Throws:

InvalidParameterException - guid is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupGovernanceDefinitionMetric

void setupGovernanceDefinitionMetric(String userId,
                                     String metricGUID,
                                     String governanceDefinitionGUID,
                                     String rationale)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Create a link to show that a governance metric supports the requirements of one of the governance policies. If the link already exists the rationale is updated.

Parameters:

userId - calling user

metricGUID - unique identifier of the governance metric

governanceDefinitionGUID - unique identifier of the governance definition

rationale - description of how the metric supports the driver

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearGovernanceDefinitionMetric

void clearGovernanceDefinitionMetric(String userId,
                                     String metricGUID,
                                     String governanceDefinitionGUID)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the link between a governance metric and a governance definition.

Parameters:

userId - calling user

metricGUID - unique identifier of the governance metric

governanceDefinitionGUID - unique identifier of the governance definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceMetricByGUID

GovernanceMetricElement getGovernanceMetricByGUID(String userId,
                                                  String metricGUID)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Return information about a specific governance metric.

Parameters:

userId - calling user

metricGUID - unique identifier for the governance metrics

Returns:

properties of the governance metric

Throws:

InvalidParameterException - metricGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

findGovernanceMetrics

List<GovernanceMetricElement> findGovernanceMetrics(String userId,
                                                    String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    PropertyServerException,
                                                    UserNotAuthorizedException

Retrieve the list of governance metrics for this search string.

Parameters:

userId - the name of the calling user.

searchString - value to search for (supports wildcards).

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of metrics

Throws:

InvalidParameterException - guid invalid or the search parameter is not correctly specified, or is null.

PropertyServerException - the server is not available.

UserNotAuthorizedException - the calling user is not authorized to issue the call.