Package org.odpi.openmetadata.frameworks.discovery.properties

Class RequestForActionAnnotation

java.lang.Object
org.odpi.openmetadata.frameworks.discovery.properties.PropertyBase
org.odpi.openmetadata.frameworks.discovery.properties.Annotation
org.odpi.openmetadata.frameworks.discovery.properties.DataFieldAnnotation
org.odpi.openmetadata.frameworks.discovery.properties.RequestForActionAnnotation
All Implemented Interfaces:
Serializable
public class RequestForActionAnnotation extends DataFieldAnnotation
RequestForActionAnnotation is used to record an issue that has been discovered. It is typically used when the discovery service is running quality rules and data values are discovered that are not correct.
See Also:

  • Constructor Details

    • RequestForActionAnnotation

      public RequestForActionAnnotation()
      Default constructor

    • RequestForActionAnnotation

      public RequestForActionAnnotation(RequestForActionAnnotation template)
      Copy/clone constructor
      Parameters:
      template - object to copy

  • Method Details

    • getDiscoveryActivity

      public String getDiscoveryActivity()
      Return the unique name of the discovery activity. It should be possible for the stewardship processes to know what discovery processing was running for this value.
      Returns:
      string name

    • setDiscoveryActivity

      public void setDiscoveryActivity(String discoveryActivity)
      Set up the unique name of the discovery activity. It should be possible for the stewardship processes to know what discovery processing was running for this value.
      Parameters:
      discoveryActivity - string name

    • getActionRequested

      public String getActionRequested()
      Return the identifier of the type of action that needs to be run. It should be possible for the stewardship processes to know what to run from this value.
      Returns:
      string name

    • setActionRequested

      public void setActionRequested(String actionRequested)
      Set up the identifier of the type of action that needs to be run. It should be possible for the stewardship processes to know what to run from this value.
      Parameters:
      actionRequested - string name

    • getActionProperties

      public Map<String,String> getActionProperties()
      Return the properties that will guide the governance action.
      Returns:
      map of property names to property values

    • setActionProperties

      public void setActionProperties(Map<String,String> actionProperties)
      Set up the properties that will guide the remediation action.
      Parameters:
      actionProperties - map of property names to property values

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class DataFieldAnnotation
      Returns:
      print out of variables in a JSON-style

    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class Annotation
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison

    • hashCode

      public int hashCode()
      Create a hash code for this element type.
      Overrides:
      hashCode in class Annotation
      Returns:
      int hash code