| java.lang.Object
 com.ivata.mask.validation.ValidationError
| ValidationError | | public class ValidationError implements Serializable(Code) | |
This class represents an error which occurred when data is validated for
submission.
Before new data is posted to ivata masks , it is possible to validate
it. If the data is for any reason invalid, then an instance of this class is
created to indicate what is wrong or missing ind the data (invalid date
format? missing parameter?). Multiple errors which occur can be grouped
together in a ValidationErrors instance.
This class originally appeared as part of ivata op and ivata team portal .
.
since:
ivata masks 0.4 (2002-11-11)
author:
Colin MacLeod
author:
colin.macleod@ivata.com
version:
$Revision: 1.8 $
See Also: ValidationErrors |
| Constructor Summary | |
| public | ValidationError(String resourceFieldPathParam, Field fieldParam, String errorKeyParam)
Create a new instance with the given field, and error key. | | public | ValidationError(String resourceFieldPathParam, Field fieldParam, String errorKeyParam, List parametersParam)
Create a new instance with the given field and parameters. | | public | ValidationError(String errorKeyParam, List parametersParam)
Create a new instance with the given error key and parameters.
Attributes of
this class are immutable so the values specified here cannot be
later altered.
Parameters:
errorKeyParam - label key of the error which occurred.
Parameters:
parametersParam - list of error string parameters, used to completed the errormessage. | | public | ValidationError(String resourceFieldPathParam, String bundleParam, Field fieldParam, String errorKeyParam)
Create a new instance with the given field, error key and
bundle. | | public | ValidationError(String resourceFieldPathParam, String bundleParam, Field fieldParam, String errorKeyParam, List parametersParam)
Create a new instance with the given bundle, field, label and parameters.
Attributes of this class are immutable so the values specified
here cannot be later altered.
Parameters:
bundleParam - Refer to ValidationError.getBundle.
Parameters:
resourceFieldPathParam - Refer to ValidationError.getResourceFieldPathParam.
Parameters:
fieldParam - field which contained an invalid value and caused the error.
Parameters:
errorKeyParam - label key of the error which occurred.
Parameters:
parametersParam - list of error string parameters. |
| Method Summary | |
| public String | getBundle()
Get the message resource bundle associated with this error. | | final public String | getErrorKey()
Message key of the error which occurred, from the error message
resources. | | final public Field | getField()
Get the field which contained an invalid value and caused the error. | | final public List | getParameters()
A list of error string parameters. | | public String | getResourceFieldPath()
Get the message resources field path associated with this field. | | final public String | toString()
Overridden from Object for convenience when debugging. |
| ValidationError | | public ValidationError(String resourceFieldPathParam, Field fieldParam, String errorKeyParam)(Code) | |
Create a new instance with the given field, and error key.
Attributes of this class are immutable so the values
specified here cannot be later altered.
Parameters:
resourceFieldPathParam - Refer to ValidationError.getResourceFieldPathParam.
Parameters:
fieldParam - field which contained an invalid value and caused the error.
Parameters:
errorKeyParam - key of the error which occurred. |
| ValidationError | | public ValidationError(String resourceFieldPathParam, Field fieldParam, String errorKeyParam, List parametersParam)(Code) | |
Create a new instance with the given field and parameters. Attributes of
this class are immutable so the values specified here cannot be
later altered.
Parameters:
resourceFieldPathParam - Refer to ValidationError.getResourceFieldPathParam.
Parameters:
fieldParam - field which contained an invalid value and caused the error.
Parameters:
errorKeyParam - label key of the error which occurred.
Parameters:
parametersParam - list of error string parameters, used to completed the errormessage. This attribute may benull if there are no parameters required.. |
| ValidationError | | public ValidationError(String errorKeyParam, List parametersParam)(Code) | |
Create a new instance with the given error key and parameters.
Attributes of
this class are immutable so the values specified here cannot be
later altered.
Parameters:
errorKeyParam - label key of the error which occurred.
Parameters:
parametersParam - list of error string parameters, used to completed the errormessage. This attribute may benull if there are no parameters required.. |
| ValidationError | | public ValidationError(String resourceFieldPathParam, String bundleParam, Field fieldParam, String errorKeyParam)(Code) | |
Create a new instance with the given field, error key and
bundle. Attributes of this class are immutable so the values
specified here cannot be later altered.
Parameters:
bundleParam - Refer to ValidationError.getBundle.
Parameters:
resourceFieldPathParam - Refer to ValidationError.getResourceFieldPathParam.
Parameters:
fieldParam - field which contained an invalid value and caused the error.
Parameters:
errorKeyParam - key of the error which occurred. |
| ValidationError | | public ValidationError(String resourceFieldPathParam, String bundleParam, Field fieldParam, String errorKeyParam, List parametersParam)(Code) | |
Create a new instance with the given bundle, field, label and parameters.
Attributes of this class are immutable so the values specified
here cannot be later altered.
Parameters:
bundleParam - Refer to ValidationError.getBundle.
Parameters:
resourceFieldPathParam - Refer to ValidationError.getResourceFieldPathParam.
Parameters:
fieldParam - field which contained an invalid value and caused the error.
Parameters:
errorKeyParam - label key of the error which occurred.
Parameters:
parametersParam - list of error string parameters. This attribute may benull if there are no parameters required.. |
| getBundle | | public String getBundle()(Code) | | Get the message resource bundle associated with this error. May be
null.
message resource used to localize the field name for this error. |
| getErrorKey | | final public String getErrorKey()(Code) | |
Message key of the error which occurred, from the error message
resources.
message key describing the error. |
| getField | | final public Field getField()(Code) | |
Get the field which contained an invalid value and caused the error.
the current value of field. |
| getParameters | | final public List getParameters()(Code) | |
A list of error string parameters. Depending on the value of
key, there may be many parameters describing the error in
detail. This attribute may be null if there are no
parameters required.
the current value of parameters. |
| getResourceFieldPath | | public String getResourceFieldPath()(Code) | |
Get the message resources field path associated with this field. This is
the first part of the path used to search for string in the localization
bundle.
message resource field path. |
| toString | | final public String toString()(Code) | | Overridden from Object for convenience when debugging.
the class name followed by key, field and parameters. |
|
|