oracle.jdeveloper.audit.analyzer
Interface ViolationReport

public interface ViolationReport

An interface for adding properties to a reported Audit violations. The violation reporting methods in AuditContext only allow a client to directly specify the rule and location properties of a violation. To allow a client to specify additional properties, parameters, fixes, recommended fix, and related location, the report methods return an instance of this interface.

Method Summary

void	addFix(Transform transform) Deprecated.
void	addParameter(java.lang.String name, java.lang.Object value) Adds a parameter to the violation.
void	addRelatedLocation(Location location) Adds a related location to the violation.
void	hideDefaultFixes() Deprecated.
void	setRecommendedFix(Transform transform) Sets the recommended fix for this violation.

Method Detail

addParameter

public void addParameter(java.lang.String name,
                         java.lang.Object value)

Adds a parameter to the violation. Parameters are numbered in the order they are added, starting at 0. In the message template string associated with the rule, a parameter can be referred to by index or by name. When the Audit framework uses a transform in the context of this violation, it sets any properties whose names match a parameter name to the parameter value.

addRelatedLocation

public void addRelatedLocation(Location location)

Adds a related location to the violation.

addFix

public void addFix(Transform transform)

Deprecated.

Adds a fix to the violation and hides all fixes inherited from the rule. This method should only be used if it is not possible to supply all fixes to the rule when it is constructed.

setRecommendedFix

public void setRecommendedFix(Transform transform)

Sets the recommended fix for this violation. This overrides the default fix set by the user and inherited from the rule, so the rule help should make clear that this will happen.

hideDefaultFixes

public void hideDefaultFixes()

Deprecated.

Hides the fixes inherited from the rule. This method need not be used if addFix is used.