Interface SpecialGovernanceActionInterface

  • All Known Implementing Classes:
    GovernanceEngineClient

    public interface SpecialGovernanceActionInterface
    SpecialGovernanceActionInterface defines methods that are used by governance action services to make changes to open metadata.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String createIncidentReport​(java.lang.String userId, java.lang.String qualifiedName, int domainIdentifier, java.lang.String background, java.util.List<IncidentImpactedElement> impactedResources, java.util.List<IncidentDependency> previousIncidents, java.util.Map<java.lang.String,​java.lang.Integer> incidentClassifiers, java.util.Map<java.lang.String,​java.lang.String> additionalProperties, java.lang.String originatorGUID)
      Create an incident report to capture the situation detected by this governance action service.
      void linkConsolidatedDuplicate​(java.lang.String userId, java.lang.String consolidatedElementGUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes, java.util.List<java.lang.String> sourceElementGUIDs)
      Identify an element that acts as a consolidated version for a set of duplicate elements.
      void linkElementsAsPeerDuplicates​(java.lang.String userId, java.lang.String metadataElement1GUID, java.lang.String metadataElement2GUID, int statusIdentifier, java.lang.String steward, java.lang.String stewardTypeName, java.lang.String stewardPropertyName, java.lang.String source, java.lang.String notes, boolean setKnownDuplicate)
      Link elements as peer duplicates.
    • Method Detail

      • linkElementsAsPeerDuplicates

        void linkElementsAsPeerDuplicates​(java.lang.String userId,
                                          java.lang.String metadataElement1GUID,
                                          java.lang.String metadataElement2GUID,
                                          int statusIdentifier,
                                          java.lang.String steward,
                                          java.lang.String stewardTypeName,
                                          java.lang.String stewardPropertyName,
                                          java.lang.String source,
                                          java.lang.String notes,
                                          boolean setKnownDuplicate)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
        Parameters:
        userId - caller's userId
        metadataElement1GUID - unique identifier of the metadata element at end 1 of the relationship
        metadataElement2GUID - unique identifier of the metadata element at end 2 of the relationship
        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
        setKnownDuplicate - boolean flag indicating whether the KnownDuplicate classification should be set on the linked entities.
        Throws:
        InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
        UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
        PropertyServerException - there is a problem with the metadata store
      • linkConsolidatedDuplicate

        void linkConsolidatedDuplicate​(java.lang.String userId,
                                       java.lang.String consolidatedElementGUID,
                                       int statusIdentifier,
                                       java.lang.String steward,
                                       java.lang.String stewardTypeName,
                                       java.lang.String stewardPropertyName,
                                       java.lang.String source,
                                       java.lang.String notes,
                                       java.util.List<java.lang.String> sourceElementGUIDs)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.)
        Parameters:
        userId - caller's userId
        consolidatedElementGUID - unique identifier of the metadata 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
        sourceElementGUIDs - List of the source elements that must be linked to the consolidated element. It is assumed that they already have the KnownDuplicateClassification.
        Throws:
        InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
        UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
        PropertyServerException - there is a problem with the metadata store
      • createIncidentReport

        java.lang.String createIncidentReport​(java.lang.String userId,
                                              java.lang.String qualifiedName,
                                              int domainIdentifier,
                                              java.lang.String background,
                                              java.util.List<IncidentImpactedElement> impactedResources,
                                              java.util.List<IncidentDependency> previousIncidents,
                                              java.util.Map<java.lang.String,​java.lang.Integer> incidentClassifiers,
                                              java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                              java.lang.String originatorGUID)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.
        Parameters:
        userId - caller's userId
        qualifiedName - unique identifier to give this new incident report
        domainIdentifier - governance domain associated with this action (0=ALL)
        background - description of the situation
        impactedResources - details of the resources impacted by this situation
        previousIncidents - links to previous incident reports covering this situation
        incidentClassifiers - initial classifiers for the incident report
        additionalProperties - additional arbitrary properties for the incident reports
        originatorGUID - the unique identifier of the person or process that created the incident
        Returns:
        unique identifier of the resulting incident report
        Throws:
        InvalidParameterException - null or non-unique qualified name for the incident report
        UserNotAuthorizedException - this governance action service is not authorized to create an incident report
        PropertyServerException - there is a problem with the metadata store