org.kuali.student.r2.common.dto

Class ValidationResultInfo

java.lang.Object

org.kuali.student.r2.common.dto.ValidationResultInfo

All Implemented Interfaces:

Serializable, ValidationResult

public class ValidationResultInfo
extends Object
implements ValidationResult, Serializable

Information about the results of a data validation.

Author:

nwright

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.kuali.student.r2.common.infc.ValidationResult

ValidationResult.ErrorLevel

Constructor Summary

Constructors

Constructor and Description
ValidationResultInfo() Constructs a new ValidationResultInfo.
ValidationResultInfo(String element) convenience constructor carried over from R1
ValidationResultInfo(String element, Object invalidData) convenience constructor carried over from R1
ValidationResultInfo(ValidationResult result) Constructs a new ValidationResultInfo from another ValidationResult.

Method Summary

Methods

Modifier and Type	Method and Description
String	getElement() Identifies the element (field) that is the focus of the validation.
ValidationResult.ErrorLevel	getErrorLevel() Deprecated.
Object	getInvalidData() not part of the contract but carried over from r1
ValidationResult.ErrorLevel	getLevel() convenience method carried over from R1 Use getErrorLevel () instead
String	getMessage() Message explaining this validation result If an error it is an an error message.
static boolean	hasValidationErrors(List<ValidationResultInfo> validationResults, ValidationResult.ErrorLevel threshold, List<String> ignoreFields)
boolean	isError() convenience method carried over from R1
boolean	isOk() Convenience method from R1 to check if this is ok
boolean	isWarn() convenience method carried over from R1
void	setElement(String element)
void	setError(String message) Convenience method.
void	setErrorLevel(ValidationResult.ErrorLevel errorLevel)
void	setInvalidData(Object invalidData) not part of the contract but carried over from r1
void	setLevel(ValidationResult.ErrorLevel level)
void	setMessage(String message)
void	setWarn(String message) convenience method carried over from R1
void	setWarning(String message) Convenience method.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationResultInfo

public ValidationResultInfo()

Constructs a new ValidationResultInfo.

ValidationResultInfo

public ValidationResultInfo(String element)

convenience constructor carried over from R1

ValidationResultInfo

public ValidationResultInfo(String element,
                    Object invalidData)

convenience constructor carried over from R1

ValidationResultInfo

public ValidationResultInfo(ValidationResult result)

Constructs a new ValidationResultInfo from another ValidationResult.

Parameters:

result - the ValidationResult to copy

Method Detail

getErrorLevel

@Deprecated
public ValidationResult.ErrorLevel getErrorLevel()

Deprecated.

This is for compatibility with R1. Use getLevel instead

setErrorLevel

public void setErrorLevel(ValidationResult.ErrorLevel errorLevel)

isOk

public boolean isOk()

Convenience method from R1 to check if this is ok

isWarn

public boolean isWarn()

convenience method carried over from R1

setWarn

public void setWarn(String message)

convenience method carried over from R1

isError

public boolean isError()

convenience method carried over from R1

getMessage

public String getMessage()

Description copied from interface: ValidationResult

Message explaining this validation result If an error it is an an error message. TODO: decide if this is a key that then gets resolved into a real localized message using the message service or the final localized message itself

Specified by:

getMessage in interface ValidationResult

setMessage

public void setMessage(String message)

getElement

public String getElement()

Description copied from interface: ValidationResult

Identifies the element (field) that is the focus of the validation. Uses xpath (dot) notation to navigate to the field, for example: officialIdentifier.code TODO: find out how repeating substructures are handled in this notation, with [n] occurrence brackets?

Specified by:

getElement in interface ValidationResult

setElement

public void setElement(String element)

getLevel

public ValidationResult.ErrorLevel getLevel()

convenience method carried over from R1 Use getErrorLevel () instead

Specified by:

getLevel in interface ValidationResult

setLevel

public void setLevel(ValidationResult.ErrorLevel level)

getInvalidData

public Object getInvalidData()

not part of the contract but carried over from r1

setInvalidData

public void setInvalidData(Object invalidData)

not part of the contract but carried over from r1

toString

public String toString()

Overrides:

toString in class Object

setWarning

public void setWarning(String message)

Convenience method. Adds a message with an error level of WARN

Parameters:

message - the warning message

setError

public void setError(String message)

Convenience method. Adds a message with an error level of ERROR

Parameters:

message - the error message to add

hasValidationErrors

public static boolean hasValidationErrors(List<ValidationResultInfo> validationResults,
                          ValidationResult.ErrorLevel threshold,
                          List<String> ignoreFields)