Package org.odpi.openmetadata.accessservices.assetmanager.api

Interface StewardshipExchangeInterface

public interface StewardshipExchangeInterface

The StewardshipExchangeInterface supports the exchange of relationships (such as SemanticAssignment) and classifications that are added by stewards (or automated stewardship processes) such as Confidentiality.

Method Summary

Modifier and Type	Method	Description
void	addIncompleteClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Classify the element with the Incomplete classification to indicate that it has more details to come.
void	addMementoClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.
void	clearIncompleteClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the Incomplete designation from the element.
void	clearMementoClassification(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)	Remove the memento designation from the element.

Method Detail

addMementoClassification

void addMementoClassification(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String elementGUID,
                              String elementExternalIdentifier,
                              Date effectiveTime,
                              boolean forLineage,
                              boolean forDuplicateProcessing)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Classify the element with the Memento classification to indicate that it has been logically deleted for by lineage requests.

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

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

clearMementoClassification

void clearMementoClassification(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String elementGUID,
                                String elementExternalIdentifier,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the memento designation from the 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

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

addIncompleteClassification

void addIncompleteClassification(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String elementGUID,
                                 String elementExternalIdentifier,
                                 Date effectiveTime,
                                 boolean forLineage,
                                 boolean forDuplicateProcessing)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Classify the element with the Incomplete classification to indicate that it has more details to come.

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

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)

clearIncompleteClassification

void clearIncompleteClassification(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String elementGUID,
                                   String elementExternalIdentifier,
                                   Date effectiveTime,
                                   boolean forLineage,
                                   boolean forDuplicateProcessing)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the Incomplete designation from the 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

elementExternalIdentifier - unique identifier of the element in the external asset manager

effectiveTime - optional date for effective time of the query. Null means any effective time

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

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)