Interface DuplicateManagementInterface

  • All Known Implementing Classes:
    StewardshipAction

    public interface DuplicateManagementInterface
    DuplicateManagementInterface defines the operations to manage the linking of elements that are duplicates of one another.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ElementStub getConsolidatedDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Return details of the consolidated duplicate for a requested element.
      java.util.List<ElementStub> getContributingDuplicates​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, int startFrom, int pageSize)
      List the elements that are contributing to a consolidating duplicate element.
      java.util.List<DuplicateElement> getPeerDuplicates​(java.lang.String userId, java.lang.String elementGUID, int startFrom, int pageSize)
      List the elements that are linked as peer duplicates to the requested element.
      void linkElementsAsDuplicates​(java.lang.String userId, java.lang.String element1GUID, java.lang.String element2GUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes)
      Create a simple relationship between two elements.
      void linkElementToConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, java.lang.String contributingElementGUID)
      Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.
      void markAsConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes)
      Mark an element as a consolidated duplicate (or update the properties if it is already marked as such).
      void markElementAsKnownDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Classify an element as a known duplicate.
      void removeConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID)
      Remove the consolidated duplicate element and the links to the elements that contributed to its values.
      void unlinkElementFromConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedDuplicateGUID, java.lang.String contributingElementGUID)
      Remove the relationship between two elements that marks them as duplicates.
      void unlinkElementsAsDuplicates​(java.lang.String userId, java.lang.String element1GUID, java.lang.String element2GUID)
      Remove the relationship between two elements that marks them as duplicates.
      void unmarkElementAsKnownDuplicate​(java.lang.String userId, java.lang.String elementGUID)
      Remove the classification that identifies this element as a known duplicate.
    • Method Detail

      • linkElementsAsDuplicates

        void linkElementsAsDuplicates​(java.lang.String userId,
                                      java.lang.String element1GUID,
                                      java.lang.String element2GUID,
                                      int statusIdentifier,
                                      java.lang.String steward,
                                      java.lang.String stewardTypeName,
                                      java.lang.String stewardPropertyName,
                                      java.lang.String source,
                                      java.lang.String notes)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Create a simple relationship between two elements. These elements must be of the same type. If the relationship already exists, the properties are updated.
        Parameters:
        userId - calling user
        element1GUID - unique identifier of first element
        element2GUID - unique identifier of second element
        statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
        steward - identifier of the steward
        stewardTypeName - type of element used to identify the steward
        stewardPropertyName - property name used to identify steward
        source - source of the duplicate detection processing
        notes - notes for the steward
        Throws:
        InvalidParameterException - one of the parameters is null or invalid, or the elements are of different types
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • markAsConsolidatedDuplicate

        void markAsConsolidatedDuplicate​(java.lang.String userId,
                                         java.lang.String consolidatedDuplicateGUID,
                                         int statusIdentifier,
                                         java.lang.String steward,
                                         java.lang.String stewardTypeName,
                                         java.lang.String stewardPropertyName,
                                         java.lang.String source,
                                         java.lang.String notes)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Mark an element as a consolidated duplicate (or update the properties if it is already marked as such). This method assumes that a standard create method has been used to create the element first using the values from contributing elements. It is just adding the ConsolidatedDuplicate classification to the element.
        Parameters:
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of the element that contains the consolidated information from a collection of elements that are all duplicates of one another.
        statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
        steward - identifier of the steward
        stewardTypeName - type of element used to identify the steward
        stewardPropertyName - property name used to identify steward
        source - source of the duplicate detection processing
        notes - notes for the steward
        Throws:
        InvalidParameterException - one of the parameters is null or invalid
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • linkElementToConsolidatedDuplicate

        void linkElementToConsolidatedDuplicate​(java.lang.String userId,
                                                java.lang.String consolidatedDuplicateGUID,
                                                java.lang.String contributingElementGUID)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.
        Parameters:
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of consolidated duplicate
        contributingElementGUID - unique identifier of duplicate element
        Throws:
        InvalidParameterException - one of the parameters is null or invalid or the elements are not linked as duplicates
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem
      • unlinkElementFromConsolidatedDuplicate

        void unlinkElementFromConsolidatedDuplicate​(java.lang.String userId,
                                                    java.lang.String consolidatedDuplicateGUID,
                                                    java.lang.String contributingElementGUID)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Remove the relationship between two elements that marks them as duplicates.
        Parameters:
        userId - calling user
        consolidatedDuplicateGUID - unique identifier of consolidated duplicate
        contributingElementGUID - unique identifier of duplicate element
        Throws:
        InvalidParameterException - one of the parameters is null or invalid or the elements are not linked as duplicates
        PropertyServerException - problem accessing property server
        UserNotAuthorizedException - security access problem