Package 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	Description
void	clearGovernanceDefinitionMetric(String userId, String metricGUID, String governanceDefinitionGUID)	Remove the link between a governance metric and a governance definition.
void	clearGovernanceExpectations(String userId, String elementGUID)	Remove the governance expectations classification from the element.
void	clearGovernanceMeasurements(String userId, String elementGUID)	Remove the measurements from the element.
void	clearGovernanceMeasurementsDataSet(String userId, String dataSetGUID)	Remove the governance data designation from the data set.
void	clearGovernanceResults(String userId, String metricGUID, String dataSetGUID)	Remove the link between a governance metric and a data set.
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	setGovernanceExpectations(String userId, String elementGUID, GovernanceExpectationsProperties properties)	Classify the element to indicate the expected values of the governance measurements.
void	setGovernanceMeasurements(String userId, String elementGUID, GovernanceMeasurementsProperties properties)	Classify the element with relevant governance measurements.
void	setGovernanceMeasurementsDataSet(String userId, String dataSetGUID, GovernanceMeasurementsDataSetProperties properties)	Classify the data set to indicate that contains governance measurements.
void	setupGovernanceDefinitionMetric(String userId, String metricGUID, String governanceDefinitionGUID, GovernanceDefinitionMetricProperties rationale)	Create a link to show that a governance metric supports the requirements of one of the governance policies.
void	setupGovernanceResults(String userId, String metricGUID, String dataSetGUID, GovernanceResultsProperties properties)	Create a link to show which data set holds the measurements for a data set.
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,
                                     GovernanceDefinitionMetricProperties 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

setupGovernanceResults

void setupGovernanceResults(String userId,
                            String metricGUID,
                            String dataSetGUID,
                            GovernanceResultsProperties properties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create a link to show which data set holds the measurements for a data set.

Parameters:

userId - calling user

metricGUID - unique identifier of the governance metric

dataSetGUID - unique identifier of the governance definition

properties - description of how the data set supports the metric

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearGovernanceResults

void clearGovernanceResults(String userId,
                            String metricGUID,
                            String dataSetGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Remove the link between a governance metric and a data set.

Parameters:

userId - calling user

metricGUID - unique identifier of the governance metric

dataSetGUID - unique identifier of the data set

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setGovernanceMeasurementsDataSet

void setGovernanceMeasurementsDataSet(String userId,
                                      String dataSetGUID,
                                      GovernanceMeasurementsDataSetProperties properties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Classify the data set to indicate that contains governance measurements.

Parameters:

userId - calling user

dataSetGUID - unique identifier of the metadata element to classify

properties - properties of the data set's measurements

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)

clearGovernanceMeasurementsDataSet

void clearGovernanceMeasurementsDataSet(String userId,
                                        String dataSetGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Remove the governance data designation from the data set.

Parameters:

userId - calling user

dataSetGUID - unique identifier of the metadata element to classify

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)

setGovernanceExpectations

void setGovernanceExpectations(String userId,
                               String elementGUID,
                               GovernanceExpectationsProperties properties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Classify the element to indicate the expected values of the governance measurements. Can be used to create or update the values.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to classify

properties - properties of the data set's measurements

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)

clearGovernanceExpectations

void clearGovernanceExpectations(String userId,
                                 String elementGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the governance expectations classification from the element.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to classify

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)

setGovernanceMeasurements

void setGovernanceMeasurements(String userId,
                               String elementGUID,
                               GovernanceMeasurementsProperties properties)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Classify the element with relevant governance measurements. Can be used to create or update the values.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to classify

properties - properties of the data set's measurements

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)

clearGovernanceMeasurements

void clearGovernanceMeasurements(String userId,
                                 String elementGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the measurements from the element.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to classify

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)

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.