Package org.faktorips.runtime.validation

Class GenericRelevanceValidation

java.lang.Object

org.faktorips.runtime.validation.GenericRelevanceValidation

public class GenericRelevanceValidation
extends java.lang.Object

Class for validating the attribute relevance and value range.

Since:

21.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GenericRelevanceValidation.Error

Constructor Summary

Constructors

Constructor	Description
GenericRelevanceValidation(IModelObject modelObject, java.lang.Class<? extends IModelObject> definingModelObjectClass, PolicyAttribute policyAttribute, IGenericAttributeValidationConfiguration config)

Method Summary

Modifier and Type	Method	Description
static MessageList	of(IModelObject modelObject, java.lang.Class<? extends IModelObject> definingModelObjectClass, java.lang.String propertyName, IValidationContext validationContext)	Creates a GenericRelevanceValidation for the given model object's attribute using the validation context to get the IGenericAttributeValidationConfiguration and validates the attribute.
MessageList	validate()	Checks the attribute for the following violations: Mandatory violation: The attribute is a Relevance.MANDATORY field and the value is missing.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericRelevanceValidation

public GenericRelevanceValidation(IModelObject modelObject,
                                  java.lang.Class<? extends IModelObject> definingModelObjectClass,
                                  PolicyAttribute policyAttribute,
                                  IGenericAttributeValidationConfiguration config)

Method Detail

of

public static MessageList of(IModelObject modelObject,
                             java.lang.Class<? extends IModelObject> definingModelObjectClass,
                             java.lang.String propertyName,
                             IValidationContext validationContext)

Creates a GenericRelevanceValidation for the given model object's attribute using the validation context to get the IGenericAttributeValidationConfiguration and validates the attribute.

Parameters:

modelObject - the model object to validate

propertyName - the name of a PolicyAttribute of the model object

validationContext - the context containing information on what to validate and how to create error messages

Returns:

the messages resulting from the validation, if any, or an empty message list if validation was successful (or not performed because of IGenericAttributeValidationConfiguration.shouldValidate(PolicyAttribute, IModelObject) returning false

validate

public MessageList validate()

Checks the attribute for the following violations:

• Mandatory violation: The attribute is a Relevance.MANDATORY field and the value is missing.
• Irrelevant violation: The value set is empty(Relevance.IRRELEVANT), so the attribute cannot have a value.
• Value set violation: The attribute contains a value that is not part of the value set.

Returns:

A MessageList with the validation results