Package org.odpi.openmetadata.frameworks.surveyaction.properties

Class RequestForActionAnnotation

java.lang.Object

org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation

org.odpi.openmetadata.frameworks.surveyaction.properties.DataFieldAnnotation

org.odpi.openmetadata.frameworks.surveyaction.properties.RequestForActionAnnotation

public class RequestForActionAnnotation
extends DataFieldAnnotation

RequestForActionAnnotation is used to record an issue that has been discovered. It is typically used when the survey action service is running quality rules and data values are discovered that are not correct.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

CURRENT_AUDIT_HEADER_VERSION

Constructor Summary

Constructors

Constructor	Description
RequestForActionAnnotation()	Default constructor
RequestForActionAnnotation(RequestForActionAnnotation template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
Map<String,String>	getActionProperties()	Return the properties that will guide the governance action.
String	getActionRequested()	Return the identifier of the type of action that needs to be run.
List<String>	getActionTargetGUIDs()	Return the list of unique identifiers for the request for action target elements.
String	getSurveyActivity()	Return the unique name of the discovery activity.
int	hashCode()	Create a hash code for this element type.
void	setActionProperties(Map<String,String> actionProperties)	Set up the properties that will guide the remediation action.
void	setActionRequested(String actionRequested)	Set up the identifier of the type of action that needs to be run.
void	setActionTargetGUIDs(List<String> actionTargetGUIDs)	Set up the list of unique identifiers for the request for action target elements.
void	setSurveyActivity(String surveyActivity)	Set up the unique name of the discovery activity.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.Annotation

getAdditionalProperties, getAnalysisStep, getAnnotationStatus, getAnnotationSubjects, getAnnotationType, getConfidenceLevel, getExplanation, getExpression, getJsonProperties, getReviewComment, getReviewDate, getSteward, getSummary, setAdditionalProperties, setAnalysisStep, setAnnotationStatus, setAnnotationSubjects, setAnnotationType, setConfidenceLevel, setExplanation, setExpression, setJsonProperties, setReviewComment, setReviewDate, setSteward, setSummary

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.properties.PropertyBase

getElementHeader, getExtendedProperties, getHeaderVersion, getOpenMetadataTypeName, setElementHeader, setExtendedProperties, setHeaderVersion, setOpenMetadataTypeName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RequestForActionAnnotation

public RequestForActionAnnotation()

Default constructor

RequestForActionAnnotation

public RequestForActionAnnotation(RequestForActionAnnotation template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getSurveyActivity

public String getSurveyActivity()

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

setSurveyActivity

public void setSurveyActivity(String surveyActivity)

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:

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

getActionTargetGUIDs

public List<String> getActionTargetGUIDs()

Return the list of unique identifiers for the request for action target elements.

Returns:

list of guids

setActionTargetGUIDs

public void setActionTargetGUIDs(List<String> actionTargetGUIDs)

Set up the list of unique identifiers for the request for action target elements.

Parameters:

actionTargetGUIDs - list of guids

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