com.helger.commons.errorlist

Interface IError

All Superinterfaces:

IErrorIndicator, IHasErrorID, IHasErrorLevel, ISeverityComparable<IError>, ISuccessIndicator, Serializable

All Known Implementing Classes:

SingleError

public interface IError
extends IHasErrorID, IHasErrorLevel, ISuccessIndicator, IErrorIndicator, ISeverityComparable<IError>, Serializable

Base interface for a single error, that has an error ID, and error level, and error field name and an error text.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
String	getErrorFieldName()
String	getErrorText()
IResourceLocation	getResourceLocation()
boolean	hasErrorFieldName()

Methods inherited from interface com.helger.commons.error.IHasErrorID

getErrorID, hasErrorID

Methods inherited from interface com.helger.commons.error.IHasErrorLevel

getErrorLevel

Methods inherited from interface com.helger.commons.state.ISuccessIndicator

isFailure, isSuccess

Methods inherited from interface com.helger.commons.state.IErrorIndicator

isError, isNoError

Methods inherited from interface com.helger.commons.error.ISeverityComparable

isEqualSevereThan, isLessOrEqualSevereThan, isLessSevereThan, isMoreOrEqualSevereThan, isMoreSevereThan

Method Detail

getErrorFieldName

@Nullable
String getErrorFieldName()

Returns:

The field for which the error occurred. May be null.

hasErrorFieldName

boolean hasErrorFieldName()

Returns:

true if a field name is present, false otherwise

getResourceLocation

@Nullable
IResourceLocation getResourceLocation()

Returns:

The error field name of this object as an IResourceLocation . If no error field name is present, null is returned, else an IResourceLocation with the field name set is returned.

getErrorText

@Nonnull
 @Nonempty
String getErrorText()

Returns:

The message of this form error. The error text is always locale specific because this error is meant to be for a single form instance represented in a fixed locale. The result may neither be null nor empty.