Package org.faktorips.runtime.model.type

Class ValidationRule

java.lang.Object

org.faktorips.runtime.model.type.ModelElement

org.faktorips.runtime.model.type.TypePart

org.faktorips.runtime.model.type.ValidationRule

public class ValidationRule
extends TypePart

Constructor Summary

Constructors

Constructor	Description
ValidationRule(Type type, IpsValidationRule validationRuleAnnotation, IpsConfiguredValidationRule validationConfigurationRule, IpsExtensionProperties extensionProperties, Optional<Deprecation> deprecation)

Method Summary

Modifier and Type	Method	Description
Optional<ValidationRule>	findSuperValidationRule()	Returns the rule that is overridden by this rule if this rule overrides another one.
protected String	getDocumentation(Locale locale, DocumentationKind type, String fallback)
String	getMsgCode()	Returns the message code of the validation rule.
String	getName()	Returns the name of the validation rule.
Severity	getSeverity()	Returns the Severity of the validation rule.
ValidationRule	getSuperValidationRule()	Returns the rule that is overridden by this rule if this rule overrides another one.
boolean	isActivatedByDefault()	Returns whether this validation rule is activated by default.
boolean	isChangingOverTime()	Returns whether this validation rule is changing over time.
boolean	isOverriding()	Returns true if this rule overrides another rule.
boolean	isProductRelevant()	Returns whether this validation rule can be configured by a product component.
String	toString()

Methods inherited from class org.faktorips.runtime.model.type.TypePart

getMessageHelper, getMessageKey, getModelType, getType, getTypeName, validate

Methods inherited from class org.faktorips.runtime.model.type.ModelElement

createMessageHelper, getDeprecation, getDescription, getExtensionPropertyIds, getExtensionPropertyValue, getLabel, getRelevantProductObject, getRelevantProductObject, invokeField, invokeMethod, isDeprecated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ValidationRule

public ValidationRule(Type type,
 IpsValidationRule validationRuleAnnotation,
 IpsConfiguredValidationRule validationConfigurationRule,
 IpsExtensionProperties extensionProperties,
 Optional<Deprecation> deprecation)

Method Details

isChangingOverTime

public boolean isChangingOverTime()

Returns whether this validation rule is changing over time.

Specified by:

isChangingOverTime in class TypePart

Returns:

true if this validation rule is changing over time, otherwise false

isActivatedByDefault

public boolean isActivatedByDefault()

Returns whether this validation rule is activated by default.

Returns:

true if this validation rule is activated by default,otherwise false

isProductRelevant

public boolean isProductRelevant()

Returns whether this validation rule can be configured by a product component.

Returns:

true if this validation rule can be configured by a product component, otherwise false

getName

public String getName()

Returns the name of the validation rule.

Overrides:

getName in class ModelElement

Returns:

the name of the validation rule

getMsgCode

public String getMsgCode()

Returns the message code of the validation rule.

Returns:

the message code of the validation rule

getSeverity

public Severity getSeverity()

Returns the Severity of the validation rule.

Returns:

Severity of the validation rule

getDocumentation

protected String getDocumentation(Locale locale,
 DocumentationKind type,
 String fallback)

Overrides:

getDocumentation in class ModelElement

isOverriding

public boolean isOverriding()

Returns true if this rule overrides another rule. That means a supertype declares a rule with the same name.

Returns:

true if this rule overrides another, false if not

See Also:

• getSuperValidationRule()

getSuperValidationRule

public ValidationRule getSuperValidationRule()

Returns the rule that is overridden by this rule if this rule overrides another one. Otherwise returns null.

Returns:

The rule that is overridden by this rule.

See Also:

• isOverriding()

findSuperValidationRule

public Optional<ValidationRule> findSuperValidationRule()

Returns the rule that is overridden by this rule if this rule overrides another one. Otherwise returns null.

Returns:

The rule that is overridden by this rule.

See Also:

• isOverriding()

toString

public String toString()

Overrides:

toString in class ModelElement