Package 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	Description
void	addElementToSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, String subjectAreaName, String methodName)	Classify the element to assert that it is part of a subject area definition.
void	addGovernanceDefinitionToElement(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String elementGUID, String methodName)	Link a governance definition to an element using the GovernedBy relationship.
void	clearGovernanceDelegation(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String delegatedToDefinitionGUID)	Remove the link between a governance definition and a governance definition that is delegated to (ie provides an implementation of).
String	createGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String typeName, ExternalIdentifierProperties externalIdentifierProperties, GovernanceDefinitionProperties definitionProperties)	Create a new definition.
void	deleteGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID)	Delete a specific governance definition.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements that contain the search string.
List<GovernanceActionElement>	getActiveGovernanceActions(String userId, int startFrom, int pageSize)	Retrieve the governance actions that are still in process.
GovernanceActionTypeElement	getFirstActionType(String userId, String processGUID)	Return the governance action type that is the first step in a governance action process.
GovernanceActionElement	getGovernanceAction(String userId, String governanceActionGUID)	Request the status of an executing governance action request.
GovernanceActionProcessElement	getGovernanceActionProcessByGUID(String userId, String processGUID)	Retrieve the governance action process metadata element with the supplied unique identifier.
List<GovernanceActionProcessElement>	getGovernanceActionProcessesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action process metadata elements with a matching qualified or display name.
List<GovernanceActionElement>	getGovernanceActions(String userId, int startFrom, int pageSize)	Retrieve the governance actions that are known to the server.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String actionTypeGUID)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
GovernanceDefinitionElement	getGovernanceDefinitionByDocId(String userId, String assetManagerGUID, String assetManagerName, String documentIdentifier)	Retrieve the governance definition by its assigned unique document identifier.
GovernanceDefinitionElement	getGovernanceDefinitionByGUID(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID)	Retrieve the governance definition by the unique identifier assigned by this service when it was created.
List<NextGovernanceActionTypeElement>	getNextGovernanceActionTypes(String userId, String actionTypeGUID, int startFrom, int pageSize)	Return the lust of next action type defined for the governance action process.
void	linkDefinitions(String userId, String assetManagerGUID, String assetManagerName, String definitionOneGUID, String definitionTwoGUID, String description)	Link two related definitions together.
void	removeElementFromSubjectArea(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String externalElementIdentifier, String methodName)	Remove the subject area designation from the identified element.
void	removeGovernanceDefinitionFromElement(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String elementGUID, String methodName)	Remove the GovernedBy relationship between a governance definition and an element.
void	setupGovernanceDelegation(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, String delegatedToDefinitionGUID, String rationale)	Create a link to show that a governance definition supports the requirements of one of the governance drivers.
void	unlinkDefinitions(String userId, String assetManagerGUID, String assetManagerName, String definitionOneGUID, String definitionTwoGUID)	Remove the link between two definitions.
void	updateGovernanceDefinition(String userId, String assetManagerGUID, String assetManagerName, String definitionGUID, boolean isMergeUpdate, GovernanceDefinitionProperties definitionProperties)	Update an existing definition.

Method Detail

createGovernanceDefinition

String createGovernanceDefinition(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String typeName,
                                  ExternalIdentifierProperties externalIdentifierProperties,
                                  GovernanceDefinitionProperties definitionProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a new definition.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalIdentifierProperties - optional properties used to define an external identifier

typeName - type of definition

definitionProperties - properties of the definition

Returns:

unique identifier of the definition

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

updateGovernanceDefinition

void updateGovernanceDefinition(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String definitionGUID,
                                boolean isMergeUpdate,
                                GovernanceDefinitionProperties definitionProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update an existing definition.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - unique identifier of the definition to update

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

definitionProperties - 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

deleteGovernanceDefinition

void deleteGovernanceDefinition(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String definitionGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Delete a specific governance definition.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - unique identifier of the definition to remove

Throws:

InvalidParameterException - guid is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkDefinitions

void linkDefinitions(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     String definitionOneGUID,
                     String definitionTwoGUID,
                     String description)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException

Link two related definitions together. If the link already exists the description is updated.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionOneGUID - unique identifier of the first definition

definitionTwoGUID - unique identifier of the second definition

description - description of their relationship

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkDefinitions

void unlinkDefinitions(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String definitionOneGUID,
                       String definitionTwoGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Remove the link between two definitions.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionOneGUID - unique identifier of the first definition

definitionTwoGUID - unique identifier of the second definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setupGovernanceDelegation

void setupGovernanceDelegation(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String definitionGUID,
                               String delegatedToDefinitionGUID,
                               String rationale)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

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

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - unique identifier of the governance definition

delegatedToDefinitionGUID - unique identifier of the governance definition that is delegated to

rationale - description of how the delegation supports the definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearGovernanceDelegation

void clearGovernanceDelegation(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String definitionGUID,
                               String delegatedToDefinitionGUID)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove the link between a governance definition and a governance definition that is delegated to (ie provides an implementation of).

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - unique identifier of the governance definition

delegatedToDefinitionGUID - unique identifier of the governance definition that is delegated to

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceDefinitionByGUID

GovernanceDefinitionElement getGovernanceDefinitionByGUID(String userId,
                                                          String assetManagerGUID,
                                                          String assetManagerName,
                                                          String definitionGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the governance definition by the unique identifier assigned by this service when it was created.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - identifier of the governance definition to retrieve

Returns:

properties of the matching definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; guid is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getGovernanceDefinitionByDocId

GovernanceDefinitionElement getGovernanceDefinitionByDocId(String userId,
                                                           String assetManagerGUID,
                                                           String assetManagerName,
                                                           String documentIdentifier)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Retrieve the governance definition by its assigned unique document identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

documentIdentifier - identifier to search for

Returns:

properties of the matching definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

addGovernanceDefinitionToElement

void addGovernanceDefinitionToElement(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String definitionGUID,
                                      String elementGUID,
                                      String methodName)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Link a governance definition to an element using the GovernedBy relationship.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - identifier of the governance definition to link

elementGUID - unique identifier of the metadata element to link

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)

removeGovernanceDefinitionFromElement

void removeGovernanceDefinitionFromElement(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String definitionGUID,
                                           String elementGUID,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Remove the GovernedBy relationship between a governance definition and an element.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

definitionGUID - identifier of the governance definition to link

elementGUID - unique identifier of the metadata element to update

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)

addElementToSubjectArea

void addElementToSubjectArea(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String elementGUID,
                             String elementExternalIdentifier,
                             String subjectAreaName,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Classify the element to assert that it is part of a subject area definition.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - unique identifier of the metadata element to update

elementExternalIdentifier - unique identifier of the element 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 elementGUID,
                                  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 capability representing the caller

assetManagerName - unique name of software capability representing the caller

elementGUID - 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)

findGovernanceActionProcesses

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

Retrieve the list of governance action process 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)

getGovernanceActionProcessesByName

List<GovernanceActionProcessElement> getGovernanceActionProcessesByName(String userId,
                                                                        String name,
                                                                        int startFrom,
                                                                        int pageSize)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

Retrieve the list of governance action process 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)

getGovernanceActionProcessByGUID

GovernanceActionProcessElement getGovernanceActionProcessByGUID(String userId,
                                                                String processGUID)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier.

Parameters:

userId - calling user

processGUID - 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)

findGovernanceActionTypes

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

Retrieve the list of governance action type 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)

getGovernanceActionTypesByName

List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
                                                                 String name,
                                                                 int startFrom,
                                                                 int pageSize)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Retrieve the list of governance action type 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)

getGovernanceActionTypeByGUID

GovernanceActionTypeElement getGovernanceActionTypeByGUID(String userId,
                                                          String actionTypeGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the governance action type metadata element with the supplied unique identifier.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the governance action type

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)

getFirstActionType

GovernanceActionTypeElement getFirstActionType(String userId,
                                               String processGUID)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return the governance action type that is the first step in a governance action process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the governance action type

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)

getNextGovernanceActionTypes

List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes(String userId,
                                                                   String actionTypeGUID,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException

Return the lust of next action type defined for the governance action process.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the current governance action type

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action types.

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)

getGovernanceAction

GovernanceActionElement getGovernanceAction(String userId,
                                            String governanceActionGUID)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Request the status of an executing governance action request.

Parameters:

userId - identifier of calling user

governanceActionGUID - identifier of the governance action request.

Returns:

status enum

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.

getGovernanceActions

List<GovernanceActionElement> getGovernanceActions(String userId,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the governance actions that are known to the server.

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.

getActiveGovernanceActions

List<GovernanceActionElement> getActiveGovernanceActions(String userId,
                                                         int startFrom,
                                                         int pageSize)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Retrieve the governance actions that are still in process.

Parameters:

userId - userId of caller

startFrom - starting from element

pageSize - maximum elements to return

Returns:

list of governance action elements

Throws:

InvalidParameterException - one of the parameters is null or invalid.

UserNotAuthorizedException - user not authorized to issue this request.

PropertyServerException - there was a problem detected by the metadata store.