Package org.odpi.openmetadata.accessservices.governanceprogram.api

Interface RelatedElementsManagementInterface

All Known Implementing Classes:

CertificationManager, ExternalReferenceManager, GovernanceMetricsManager, GovernanceProgramBaseClient, GovernanceProgramReviewManager, GovernanceRoleManager, GovernanceZoneManager, RightsManager, SubjectAreaManager

public interface RelatedElementsManagementInterface

Defines the interface that is common to multiple element types

Method Summary

Modifier and Type	Method	Description
void	clearAssignmentScope(String userId, String elementGUID, String scopeGUID)	Remove an "AssignmentScope" relationship between two referenceables.
void	clearGovernanceDefinitionScope(String userId, String governanceDefinitionGUID, String scopeGUID)	Remove an "GovernanceDefinitionScope" relationship between two referenceables.
void	clearGovernanceResponsibilityAssignment(String userId, String governanceResponsibilityGUID, String personRoleGUID)	Remove a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.
void	clearGovernedBy(String userId, String elementGUID, String governanceDefinitionGUID)	Remove a "GovernedBy" relationship between two elements.
void	clearMoreInformation(String userId, String elementGUID, String detailGUID)	Remove a "MoreInformation" relationship between two referenceables.
void	clearResource(String userId, String elementGUID, String resourceGUID)	Remove a "ResourceList" relationship between two referenceables.
void	clearStakeholder(String userId, String elementGUID, String stakeholderGUID)	Remove a "Stakeholder" relationship between two referenceables.
List<RelatedElementStub>	getAssignedActors(String userId, String scopeGUID, int startFrom, int pageSize)	Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
List<RelatedElementStub>	getAssignedScopes(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
List<RelatedElementStub>	getDescriptiveElements(String userId, String detailGUID, int startFrom, int pageSize)	Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElementStub>	getGovernanceDefinitionScopes(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)	Retrieve the assigned scopes linked by the "GovernanceDefinitionScope" relationship between two referenceables.
List<GovernanceDefinitionElement>	getGovernanceDefinitionsForElement(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the governance definitions linked via a "GovernedBy" relationship to an element.
List<RelatedElementStub>	getGovernedElements(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)	Retrieve the governed elements linked via a "GovernedBy" relationship to a governance definition.
List<RelatedElementStub>	getMoreInformation(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElementStub>	getResourceList(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.
List<GovernanceRoleElement>	getResponsibleRoles(String userId, String governanceResponsibilityGUID, int startFrom, int pageSize)	Retrieve the person roles linked via a "GovernanceResponsibilityAssignment" relationship to a governance responsibility.
List<GovernanceDefinitionElement>	getRoleResponsibilities(String userId, String personRoleGUID, int startFrom, int pageSize)	Retrieve the governance responsibilities linked via a "GovernanceResponsibilityAssignment" relationship to a person role.
List<GovernanceDefinitionElement>	getScopedGovernanceDefinitions(String userId, String scopeGUID, int startFrom, int pageSize)	Retrieve the governance definitions linked by the "GovernanceDefinitionScope" relationship to a scope element.
List<RelatedElementStub>	getStakeholderCommissionedElements(String userId, String stakeholderGUID, int startFrom, int pageSize)	Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.
List<RelatedElementStub>	getStakeholders(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
List<RelatedElementStub>	getSupportedByResource(String userId, String resourceGUID, int startFrom, int pageSize)	Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.
void	setupAssignmentScope(String userId, String elementGUID, AssignmentScopeProperties properties, String scopeGUID)	Create an "AssignmentScope" relationship between an element and its scope.
void	setupGovernanceDefinitionScope(String userId, String governanceDefinitionGUID, String scopeGUID)	Create an "GovernanceDefinitionScope" relationship between a governance definition and its scope element.
void	setupGovernanceResponsibilityAssignment(String userId, String governanceResponsibilityGUID, String personRoleGUID)	Create a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.
void	setupGovernedBy(String userId, String elementGUID, RelationshipProperties properties, String governanceDefinitionGUID)	Create a "GovernedBy" relationship between an element and a governance definition.
void	setupMoreInformation(String userId, String elementGUID, RelationshipProperties properties, String detailGUID)	Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.
void	setupResource(String userId, String elementGUID, ResourceListProperties properties, String resourceGUID)	Create a "ResourceList" relationship between a consuming element and an element that represents resources.
void	setupStakeholder(String userId, String elementGUID, StakeholderProperties properties, String stakeholderGUID)	Create a "Stakeholder" relationship between an element and its stakeholder.

Method Details

setupMoreInformation

void setupMoreInformation(String userId,
 String elementGUID,
 RelationshipProperties properties,
 String detailGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "MoreInformation" relationship between an element that is descriptive and one that is providing the detail.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

properties - properties of the relationship

detailGUID - unique identifier of the element that provides the detail

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)

clearMoreInformation

void clearMoreInformation(String userId,
 String elementGUID,
 String detailGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "MoreInformation" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

detailGUID - unique identifier of the element that provides the detail

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)

getMoreInformation

List<RelatedElementStub> getMoreInformation(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getDescriptiveElements

List<RelatedElementStub> getDescriptiveElements(String userId,
 String detailGUID,
 int startFrom,
 int pageSize)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.

Parameters:

userId - calling user

detailGUID - unique identifier of the element that provides the detail

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupGovernedBy

void setupGovernedBy(String userId,
 String elementGUID,
 RelationshipProperties properties,
 String governanceDefinitionGUID)
              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "GovernedBy" relationship between an element and a governance definition.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is governed

properties - properties of the relationship

governanceDefinitionGUID - unique identifier of the element that provides the detail

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)

clearGovernedBy

void clearGovernedBy(String userId,
 String elementGUID,
 String governanceDefinitionGUID)
              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "GovernedBy" relationship between two elements.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is governed

governanceDefinitionGUID - unique identifier of the governance definition

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)

getGovernanceDefinitionsForElement

List<GovernanceDefinitionElement> getGovernanceDefinitionsForElement(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definitions linked via a "GovernedBy" relationship to an element.

Parameters:

userId - calling user

elementGUID - unique identifier of the element that is descriptive

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

pageSize - maximum number of elements to return.

Returns:

list of related governance definitions

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)

getGovernedElements

List<RelatedElementStub> getGovernedElements(String userId,
 String governanceDefinitionGUID,
 int startFrom,
 int pageSize)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governed elements linked via a "GovernedBy" relationship to a governance definition.

Parameters:

userId - calling user

governanceDefinitionGUID - unique identifier of the element that provides the detail

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupGovernanceDefinitionScope

void setupGovernanceDefinitionScope(String userId,
 String governanceDefinitionGUID,
 String scopeGUID)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create an "GovernanceDefinitionScope" relationship between a governance definition and its scope element.

Parameters:

userId - calling user

governanceDefinitionGUID - unique identifier of the governance definition

scopeGUID - unique identifier of the scope

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)

clearGovernanceDefinitionScope

void clearGovernanceDefinitionScope(String userId,
 String governanceDefinitionGUID,
 String scopeGUID)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove an "GovernanceDefinitionScope" relationship between two referenceables.

Parameters:

userId - calling user

governanceDefinitionGUID - unique identifier of the governance definition

scopeGUID - unique identifier of the scope

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)

getGovernanceDefinitionScopes

List<RelatedElementStub> getGovernanceDefinitionScopes(String userId,
 String governanceDefinitionGUID,
 int startFrom,
 int pageSize)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the assigned scopes linked by the "GovernanceDefinitionScope" relationship between two referenceables.

Parameters:

userId - calling user

governanceDefinitionGUID - unique identifier of the governance definition

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getScopedGovernanceDefinitions

List<GovernanceDefinitionElement> getScopedGovernanceDefinitions(String userId,
 String scopeGUID,
 int startFrom,
 int pageSize)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance definitions linked by the "GovernanceDefinitionScope" relationship to a scope element.

Parameters:

userId - calling user

scopeGUID - unique identifier of the scope

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupGovernanceResponsibilityAssignment

void setupGovernanceResponsibilityAssignment(String userId,
 String governanceResponsibilityGUID,
 String personRoleGUID)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.

Parameters:

userId - calling user

governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)

personRoleGUID - unique identifier of the person role 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)

clearGovernanceResponsibilityAssignment

void clearGovernanceResponsibilityAssignment(String userId,
 String governanceResponsibilityGUID,
 String personRoleGUID)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "GovernanceResponsibilityAssignment" relationship between a governance responsibility and a person role.

Parameters:

userId - calling user

governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)

personRoleGUID - unique identifier of the person role 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)

getResponsibleRoles

List<GovernanceRoleElement> getResponsibleRoles(String userId,
 String governanceResponsibilityGUID,
 int startFrom,
 int pageSize)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the person roles linked via a "GovernanceResponsibilityAssignment" relationship to a governance responsibility.

Parameters:

userId - calling user

governanceResponsibilityGUID - unique identifier of the governance responsibility (type of governance definition)

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getRoleResponsibilities

List<GovernanceDefinitionElement> getRoleResponsibilities(String userId,
 String personRoleGUID,
 int startFrom,
 int pageSize)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance responsibilities linked via a "GovernanceResponsibilityAssignment" relationship to a person role.

Parameters:

userId - calling user

personRoleGUID - unique identifier of the role

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupStakeholder

void setupStakeholder(String userId,
 String elementGUID,
 StakeholderProperties properties,
 String stakeholderGUID)
               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "Stakeholder" relationship between an element and its stakeholder.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

properties - properties of the relationship

stakeholderGUID - unique identifier of the stakeholder

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)

clearStakeholder

void clearStakeholder(String userId,
 String elementGUID,
 String stakeholderGUID)
               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "Stakeholder" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

stakeholderGUID - unique identifier of the stakeholder

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)

getStakeholders

List<RelatedElementStub> getStakeholders(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getStakeholderCommissionedElements

List<RelatedElementStub> getStakeholderCommissionedElements(String userId,
 String stakeholderGUID,
 int startFrom,
 int pageSize)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the elements commissioned by a stakeholder, linked via the "Stakeholder" relationship between two referenceables.

Parameters:

userId - calling user

stakeholderGUID - unique identifier of the stakeholder

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupAssignmentScope

void setupAssignmentScope(String userId,
 String elementGUID,
 AssignmentScopeProperties properties,
 String scopeGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create an "AssignmentScope" relationship between an element and its scope.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

properties - properties of the relationship

scopeGUID - unique identifier of the scope

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)

clearAssignmentScope

void clearAssignmentScope(String userId,
 String elementGUID,
 String scopeGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove an "AssignmentScope" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

scopeGUID - unique identifier of the scope

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)

getAssignedScopes

List<RelatedElementStub> getAssignedScopes(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getAssignedActors

List<RelatedElementStub> getAssignedActors(String userId,
 String scopeGUID,
 int startFrom,
 int pageSize)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.

Parameters:

userId - calling user

scopeGUID - unique identifier of the scope

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

setupResource

void setupResource(String userId,
 String elementGUID,
 ResourceListProperties properties,
 String resourceGUID)
            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "ResourceList" relationship between a consuming element and an element that represents resources.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

properties - properties of the relationship

resourceGUID - unique identifier of the resource

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)

clearResource

void clearResource(String userId,
 String elementGUID,
 String resourceGUID)
            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "ResourceList" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

resourceGUID - unique identifier of the resource

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)

getResourceList

List<RelatedElementStub> getResourceList(String userId,
 String elementGUID,
 int startFrom,
 int pageSize)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of resources assigned to an element via the "ResourceList" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)

getSupportedByResource

List<RelatedElementStub> getSupportedByResource(String userId,
 String resourceGUID,
 int startFrom,
 int pageSize)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of elements assigned to a resource via the "ResourceList" relationship between two referenceables.

Parameters:

userId - calling user

resourceGUID - unique identifier of the resource

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

pageSize - maximum number of elements to return.

Returns:

list of related 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)