org.sandev.basics.structs
Class ErrorInfoStruct

java.lang.Object
  org.sandev.basics.structs.ErrorInfoStruct

Direct Known Subclasses:

ErrorInfo

public class ErrorInfoStruct
extends java.lang.Object

Describes an error or information status message. Each instance of this class is essentially a structured informational or error message.

summary fields: severity fieldname code text
This message has the following verb forms: collection
help text: Describes form processing output, such as an informational message or processing error.

Field Summary

protected java.lang.String	code Optional error code for use by the application.
protected java.lang.String	fieldname The name of the field being referenced.
protected int	severity The severity indicates what kind of a message this is, providing information used for display and processing.
protected java.lang.String	text The error or informational text from the application.

Constructor Summary

ErrorInfoStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

severity

protected int severity

The severity indicates what kind of a message this is, providing information used for display and processing. For example a display might present error messages in red with an error prefix, but just dump out informational text directly. Processing might avoid further actions in the event of an error, or continue in order to gather as much error info as possible.

declared default value: ERROR

enumerated constant values:

• INFO("Info") = 0
  
• WARNING("Warning") = 1
  
• ERROR("Error") = 2
  

declared invalid value: -1
help text: The severity indicates what kind of a message this is, so it can be displayed appropriately.

fieldname

protected java.lang.String fieldname

The name of the field being referenced. The application may optionally reference a field name as defined in a struct definition to assist with error display. By convention this uses the actual name of the field, not a display name, since the display transformations may change independently of the application itself.

declared invalid value: "INVALID_FIELDNAME"
Length in characters, normal: 15 max: 60
help text: The name of the field being referenced. Optionally filled in if an error or informational message is specific to a given field.

code

protected java.lang.String code

Optional error code for use by the application. The application can choose to use this field however it wants, for example for localized text lookup keys.

declared invalid value: "INVALID_CODE"
Length in characters, normal: 10 max: 80
help text: Optional error code for use by the application.

text

protected java.lang.String text

The error or informational text from the application.

declared invalid value: "INVALID_TEXT"
Length in characters, normal: 60 max: 255
help text: The error or informational text from the application.

Constructor Detail

ErrorInfoStruct

public ErrorInfoStruct()