Field Class Reference

The Field object is instantiated using a particular FieldType object and contains a value which confirms to that Field Type. This object is serializable. More...

Inheritance diagram for Field:

Public Member Functions
Field	clone ()
	Performs a field-for-field copy of instances of this class. More...
	Field (FieldType fieldType)
	The default Constructor creates an empty Field object and initializes all parameters with default values. More...
FieldType	getFieldType ()
	Gets the FieldType object associated with this Field. More...
String	getValue ()
	Gets the value of Field Object. More...
Boolean	isValid ()
	Gets the flag to determine field-level validation or field-level scripting failed. More...
String	getErrorDescription ()
	Gets the error description when a field validation rule fails. More...
void	setTag (String tag)
	Sets tag string to the Field Object. More...
String	getTag ()
	Gets tag string from the Field Object. More...
void	updateFieldProperties (String value, boolean isValid, String errorDescription)
	Sets multiple properties for the Field Object at one time. More...

Detailed Description

The Field object is instantiated using a particular FieldType object and contains a value which confirms to that Field Type. This object is serializable.

Field objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Constructor & Destructor Documentation

Field

(

FieldType

fieldType

)

The default Constructor creates an empty Field object and initializes all parameters with default values.

Member Function Documentation

Field clone

(

)

Performs a field-for-field copy of instances of this class.

String getErrorDescription

(

)

Gets the error description when a field validation rule fails.

Return string is not empty when field validation rule fails for field-level scripting or RTTI validation.

FieldType getFieldType

(

)

Gets the FieldType object associated with this Field.

This property will be filled in by the DocumentType Object.

String getTag

(

)

Gets tag string from the Field Object.

String getValue

(

)

Gets the value of Field Object.

Boolean isValid

(

)

Gets the flag to determine field-level validation or field-level scripting failed.

void setTag

(

String

tag

)

Sets tag string to the Field Object.

An open field for used by the application. Could be regex for example. Like a custom storage string on the field type level.

void updateFieldProperties	(	String	value,
		boolean	isValid,
		String	errorDescription
	)

Sets multiple properties for the Field Object at one time.

To ensure proper recording of AppStats events, the Field object properties are set using this single method. This method replaces individual setter methods for Value, IsValid, and ErrorDescription properties.

Parameters

value	Sets the value to the Field Object entered by the user, or extracted from an image. Must be non-null.
isValid	Sets flag to indicate if field-level validation or field-level scripting failed.
errorDescription	Sets the error description when the field validation rule fails for field-level scripting or RTTI validation. Must be non-null.

---

The documentation for this class was generated from the following file:

• kmc/klo/logistics/data/Field.java