Package org.odpi.openmetadata.accessservices.assetowner.api

Interface RelatedElementsManagementInterface

All Known Implementing Classes:

AssetCertificationManager, AssetLicenseManager, AssetOwner, AssetOwnerBaseClient, AvroFileAssetOwner, CSVFileAssetOwner, ExternalReferenceManager, FileSystemAssetOwner, ValidValuesAssetOwner

public interface RelatedElementsManagementInterface

Defines the interface that is common to multiple element types

Method Summary

Modifier and Type	Method	Description
void	clearCatalogTemplate(String userId, String elementGUID, String templateGUID)	Remove a "CatalogTemplate" relationship between two referenceables.
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>	getCatalogTemplateList(String userId, String elementGUID, int startFrom, int pageSize)	Retrieve the list of templates assigned to an element via the "CatalogTemplate" relationship.
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>	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<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.
List<RelatedElement>	getSupportedByTemplate(String userId, String templateGUID, int startFrom, int pageSize)	Retrieve the list of elements assigned to a template via the "CatalogTemplate" relationship.
void	setupCatalogTemplate(String userId, String elementGUID, String templateGUID)	Create a "CatalogTemplate" relationship between a consuming element and a template element.
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<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.

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

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)

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

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

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)

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

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

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)

setupCatalogTemplate

void setupCatalogTemplate(String userId,
 String elementGUID,
 String templateGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a "CatalogTemplate" relationship between a consuming element and a template element.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

templateGUID - unique identifier of the template

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)

clearCatalogTemplate

void clearCatalogTemplate(String userId,
 String elementGUID,
 String templateGUID)
                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a "CatalogTemplate" relationship between two referenceables.

Parameters:

userId - calling user

elementGUID - unique identifier of the element

templateGUID - unique identifier of the template

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)

getCatalogTemplateList

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

Retrieve the list of templates assigned to an element via the "CatalogTemplate" relationship.

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)

getSupportedByTemplate

List<RelatedElement> getSupportedByTemplate(String userId,
 String templateGUID,
 int startFrom,
 int pageSize)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of elements assigned to a template via the "CatalogTemplate" relationship.

Parameters:

userId - calling user

templateGUID - unique identifier of the template

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)