Package org.odpi.openmetadata.accessservices.governanceprogram.client

Class GovernanceProgramBaseClient

java.lang.Object

org.odpi.openmetadata.accessservices.governanceprogram.client.GovernanceProgramBaseClient

All Implemented Interfaces:

RelatedElementsManagementInterface

Direct Known Subclasses:

CertificationManager, ExternalReferenceManager, GovernanceClassificationLevelManager, GovernanceDefinitionManager, GovernanceDomainManager, GovernanceMetricsManager, GovernanceProgramReviewManager, GovernanceRoleManager, GovernanceStatusLevelManager, GovernanceZoneManager, RightsManager, SubjectAreaManager

public class GovernanceProgramBaseClient
extends Object
implements RelatedElementsManagementInterface

GovernanceProgramBaseClient supports the common properties and functions for the Community Profile OMAS.

Field Summary

Fields

Modifier and Type	Field	Description
protected NullRequestBody	nullRequestBody

Constructor Summary

Constructors

Constructor	Description
GovernanceProgramBaseClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramBaseClient(String serverName, String serverPlatformURLRoot, int maxPageSize, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.
GovernanceProgramBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
GovernanceProgramBaseClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
GovernanceProgramBaseClient(String serverName, String serverPlatformURLRoot, GovernanceProgramRESTClient restClient, int maxPageSize)	Create a new client that is going to be used in an OMAG Server.

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<RelatedElement>	getAssignedActors(String userId, String scopeGUID, int startFrom, int pageSize)	Retrieve the assigned actors linked by the "AssignmentScope" relationship between two referenceables.
List<RelatedElement>	getAssignedScopes(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the assigned scopes linked by the "AssignmentScope" relationship between two referenceables.
List<RelatedElement>	getDescriptiveElements(String userId, String detailGUID, int startFrom, int pageSize)	Retrieve the descriptive elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElement>	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<RelatedElement>	getGovernedElements(String userId, String governanceDefinitionGUID, int startFrom, int pageSize)	Retrieve the governed elements linked via a "GovernedBy" relationship to a governance definition.
List<RelatedElement>	getMoreInformation(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the detail elements linked via a "MoreInformation" relationship between two referenceables.
List<RelatedElement>	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<RelatedElement>	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<RelatedElement>	getStakeholders(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the stakeholder elements linked via the "Stakeholder" relationship between two referenceables.
List<RelatedElement>	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	removeReferenceable(String userId, String elementGUID, String elementGUIDParameterName, String urlTemplate, String methodName)	Remove the metadata element.
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.
void	updateGovernanceDefinitionStatus(String userId, String elementGUID, String elementGUIDParameterName, GovernanceDefinitionStatus newStatus, String propertiesParameterName, String methodName)	Update the status of a governance definition
void	updateRelationship(String userId, String relationshipGUID, String relationshipGUIDParameterName, boolean isMergeUpdate, String relationshipName, RelationshipProperties properties, String urlTemplate, String methodName)	Update the properties of a multi-link relationship.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nullRequestBody

protected NullRequestBody nullRequestBody

Constructor Detail

GovernanceProgramBaseClient

public GovernanceProgramBaseClient(String serverName,
                                   String serverPlatformURLRoot,
                                   int maxPageSize,
                                   AuditLog auditLog)
                            throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramBaseClient

public GovernanceProgramBaseClient(String serverName,
                                   String serverPlatformURLRoot)
                            throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramBaseClient

public GovernanceProgramBaseClient(String serverName,
                                   String serverPlatformURLRoot,
                                   String userId,
                                   String password)
                            throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramBaseClient

public GovernanceProgramBaseClient(String serverName,
                                   String serverPlatformURLRoot,
                                   String userId,
                                   String password,
                                   int maxPageSize,
                                   AuditLog auditLog)
                            throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

maxPageSize - pre-initialized parameter limit

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramBaseClient

public GovernanceProgramBaseClient(String serverName,
                                   String serverPlatformURLRoot,
                                   GovernanceProgramRESTClient restClient,
                                   int maxPageSize)
                            throws InvalidParameterException

Create a new client that is going to be used in an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST servers

restClient - client that issues the REST API calls

maxPageSize - maximum number of results supported by this server

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

updateGovernanceDefinitionStatus

public void updateGovernanceDefinitionStatus(String userId,
                                             String elementGUID,
                                             String elementGUIDParameterName,
                                             GovernanceDefinitionStatus newStatus,
                                             String propertiesParameterName,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Update the status of a governance definition

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to update

elementGUIDParameterName - name of parameter passing the elementGUID

newStatus - new status

propertiesParameterName - name of parameter passing the properties

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)

updateRelationship

public void updateRelationship(String userId,
                               String relationshipGUID,
                               String relationshipGUIDParameterName,
                               boolean isMergeUpdate,
                               String relationshipName,
                               RelationshipProperties properties,
                               String urlTemplate,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Update the properties of a multi-link relationship.

Parameters:

userId - calling user

relationshipGUID - unique identifier of the primary element

relationshipGUIDParameterName - name of parameter passing the relationshipGUID

isMergeUpdate - should the supplied properties overlay the existing properties or replace them

relationshipName - type name of relationship

properties - describes the properties for the relationship

urlTemplate - URL to call (no expected placeholders)

methodName - calling method

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeReferenceable

public void removeReferenceable(String userId,
                                String elementGUID,
                                String elementGUIDParameterName,
                                String urlTemplate,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the metadata element.

Parameters:

userId - calling user

elementGUID - unique identifier of the metadata element to remove

elementGUIDParameterName - name of parameter passing the elementGUID

urlTemplate - URL to call (no expected placeholders)

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)

setupMoreInformation

public 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.

Specified by:

setupMoreInformation in interface RelatedElementsManagementInterface

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

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

Remove a "MoreInformation" relationship between two referenceables.

Specified by:

clearMoreInformation in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getMoreInformation in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getDescriptiveElements in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

setupGovernedBy in interface RelatedElementsManagementInterface

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

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

Remove a "GovernedBy" relationship between two elements.

Specified by:

clearGovernedBy in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

getGovernanceDefinitionsForElement in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getGovernedElements in interface RelatedElementsManagementInterface

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

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

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

Specified by:

setupGovernanceDefinitionScope in interface RelatedElementsManagementInterface

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

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

Remove an "GovernanceDefinitionScope" relationship between two referenceables.

Specified by:

clearGovernanceDefinitionScope in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getGovernanceDefinitionScopes in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

getScopedGovernanceDefinitions in interface RelatedElementsManagementInterface

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

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

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

Specified by:

setupGovernanceResponsibilityAssignment in interface RelatedElementsManagementInterface

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

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

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

Specified by:

clearGovernanceResponsibilityAssignment in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

getResponsibleRoles in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

getRoleResponsibilities in interface RelatedElementsManagementInterface

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

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

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

Specified by:

setupStakeholder in interface RelatedElementsManagementInterface

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

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

Remove a "Stakeholder" relationship between two referenceables.

Specified by:

clearStakeholder in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getStakeholders in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getStakeholderCommissionedElements in interface RelatedElementsManagementInterface

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

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

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

Specified by:

setupAssignmentScope in interface RelatedElementsManagementInterface

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

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

Remove an "AssignmentScope" relationship between two referenceables.

Specified by:

clearAssignmentScope in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getAssignedScopes in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getAssignedActors in interface RelatedElementsManagementInterface

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

public 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.

Specified by:

setupResource in interface RelatedElementsManagementInterface

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

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

Remove a "ResourceList" relationship between two referenceables.

Specified by:

clearResource in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getResourceList in interface RelatedElementsManagementInterface

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

public List<RelatedElement> 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.

Specified by:

getSupportedByResource in interface RelatedElementsManagementInterface

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)