org.odpi.openmetadata.accessservices.assetmanager.api

Interface GovernanceExchangeInterface

public interface GovernanceExchangeInterface

The GovernanceExchangeInterface enables the exchange of governance definitions between an external asset manager and open metadata. It includes the exchanges of governance definitions such as GovernancePolicy and GovernanceRule as well as classifications set up by the governance teams such as SubjectArea classification.

Method Summary

Modifier and Type	Method and Description
void	addElementToSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier, String subjectAreaName, String methodName) Classify the element to asset that the definitions it represents are part of a subject area definition.
void	removeElementFromSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID, String externalElementIdentifier, String methodName) Remove the subject area designation from the identified element.

Method Detail

addElementToSubjectArea

void addElementToSubjectArea(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String glossaryCategoryGUID,
                             String glossaryCategoryExternalIdentifier,
                             String subjectAreaName,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Classify the element to asset that the definitions it represents are part of a subject area definition.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

glossaryCategoryGUID - unique identifier of the metadata element to update

glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager

subjectAreaName - qualified name of subject area

methodName - calling method

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)

removeElementFromSubjectArea

void removeElementFromSubjectArea(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String openMetadataGUID,
                                  String externalElementIdentifier,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove the subject area designation from the identified element.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

openMetadataGUID - unique identifier of the metadata element to update

externalElementIdentifier - unique identifier of the equivalent element in the external asset manager

methodName - calling method

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)