oracle.jdeveloper.audit.extension

Class RuleDefinition

java.lang.Object

oracle.jdeveloper.audit.extension.Definition

oracle.jdeveloper.audit.extension.TopLevelDefinition

oracle.jdeveloper.audit.extension.BeanDefinition

oracle.jdeveloper.audit.extension.RuleDefinition

All Implemented Interfaces:

HasCategory, HasTransformBindings, org.xml.sax.Locator

public class RuleDefinition
extends BeanDefinition
implements HasCategory, HasTransformBindings

Property Summary

Type	Property and Description
boolean	hasEnabled

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTML_MESSAGE_KEY The key for the message text of a rule.
static java.lang.String	MESSAGE_KEY The key for the message text of a rule.

Fields inherited from class oracle.jdeveloper.audit.extension.TopLevelDefinition

DESCRIPTION_KEY, LABEL_KEY

Constructor Summary

Constructors

Constructor and Description
RuleDefinition(java.lang.String id, CategoryDefinition category, ExtensionBundle bundle, DefinitionContext context)

Method Summary

Modifier and Type	Method and Description
void	addTransformBinding(TransformBinding binding)
CategoryDefinition	getCategory()
java.util.Collection<ParameterDefinition>	getParameters()
Severity	getSeverity()
java.util.Collection<java.lang.String>	getSuppressionIds()
java.util.Collection<TransformBinding>	getTransformBindings()
java.util.Collection<java.lang.String>	getVariations()
boolean	hasEnabledProperty()
java.lang.String	htmlMessage(java.lang.String variation) Gets the localized HTML violation message for a violation of this rule from its localizer using this key for a default (null) variation:
boolean	isAssist()
boolean	isMandatoryError()
java.lang.String	message(java.lang.String variation) Gets the localized violation message for a violation of this rule from its localizer using this key for a default (null) variation:
java.lang.String[]	messages()
void	setCategory(CategoryDefinition category)
void	setMandatoryError(boolean mandatoryError)
void	setParameters(java.util.Collection<ParameterDefinition> parameters)
void	setSeverity(Severity severity)
void	setSuppressionIds(java.util.Collection<java.lang.String> suppressionIds)
void	setVariations(java.util.Collection<java.lang.String> variations)

Methods inherited from class oracle.jdeveloper.audit.extension.BeanDefinition

getImplementationClass, getValue, getValues, isEnabledByDefault, setImplementationClass, setValue, setValues

Methods inherited from class oracle.jdeveloper.audit.extension.TopLevelDefinition

addDeprecatedId, bind, description, equals, formattedString, formattedString, getDeprecatedIds, getElementName, getExtensionBundle, getId, getName, getStrings, hashCode, label, missingLabel, missingString, propertyDescription, propertyLabel, propertyString, setStrings, string, toString

Methods inherited from class oracle.jdeveloper.audit.extension.Definition

getColumnNumber, getContext, getExtensionId, getLineNumber, getPublicId, getSystemId, isExtensionLoaded, log, log

Methods inherited from class java.lang.Object

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

Property Detail

hasEnabled

public boolean hasEnabledProperty

Specified by:

hasEnabledProperty in class BeanDefinition

Field Detail

MESSAGE_KEY

public static final java.lang.String MESSAGE_KEY

The key for the message text of a rule.

See Also:

message(java.lang.String), Constant Field Values

HTML_MESSAGE_KEY

public static final java.lang.String HTML_MESSAGE_KEY

The key for the message text of a rule.

See Also:

htmlMessage(java.lang.String), Constant Field Values

Constructor Detail

RuleDefinition

public RuleDefinition(java.lang.String id,
                      CategoryDefinition category,
                      ExtensionBundle bundle,
                      DefinitionContext context)

Method Detail

setCategory

public void setCategory(CategoryDefinition category)

Specified by:

setCategory in interface HasCategory

getCategory

public CategoryDefinition getCategory()

Specified by:

getCategory in interface HasCategory

hasEnabledProperty

public boolean hasEnabledProperty()

Specified by:

hasEnabledProperty in class BeanDefinition

getSeverity

public Severity getSeverity()

isAssist

public boolean isAssist()

setSeverity

public void setSeverity(Severity severity)

getParameters

public java.util.Collection<ParameterDefinition> getParameters()

setParameters

public void setParameters(java.util.Collection<ParameterDefinition> parameters)

getVariations

public java.util.Collection<java.lang.String> getVariations()

setVariations

public void setVariations(java.util.Collection<java.lang.String> variations)

getTransformBindings

public java.util.Collection<TransformBinding> getTransformBindings()

Specified by:

getTransformBindings in interface HasTransformBindings

addTransformBinding

public void addTransformBinding(TransformBinding binding)

Specified by:

addTransformBinding in interface HasTransformBindings

isMandatoryError

public boolean isMandatoryError()

setMandatoryError

public void setMandatoryError(boolean mandatoryError)

getSuppressionIds

public java.util.Collection<java.lang.String> getSuppressionIds()

setSuppressionIds

public void setSuppressionIds(java.util.Collection<java.lang.String> suppressionIds)

message

public java.lang.String message(java.lang.String variation)

Gets the localized violation message for a violation of this rule from its localizer using this key for a default (null) variation:

 "rule." + getName() + ".message"
 

and the first defined of these keys for a named variation:

 "rule." + getName() + "." + violation.getVariation() + ".message"
 "rule." + getName() + ".message"
 

htmlMessage

public java.lang.String htmlMessage(java.lang.String variation)

Gets the localized HTML violation message for a violation of this rule from its localizer using this key for a default (null) variation:

 "rule." + getName() + ".html-message"
 

and the first defined of these keys for a named variation:

 "rule." + getName() + "." + violation.getVariation() + ".html-message"
 "rule." + getName() + ".message"
 

f

messages

public java.lang.String[] messages()