de.ipcon.form

Class FormElementWrapper

java.lang.Object

de.ipcon.form.FormElementWrapper

All Implemented Interfaces:

java.lang.Comparable

public class FormElementWrapper
extends java.lang.Object
implements java.lang.Comparable

Wraps a `FormElementWithDisplayPropertyI` along with its associated `BO` and `AttributeI`.

This class provides convenience methods for describing the form element and its context, and implements `Comparable` for sorting based on the attribute name.

Constructor Summary

Constructors

Constructor and Description
FormElementWrapper(FormElementWithDisplayPropertyI _fe, BO _bo, AttributeI _att) Constructs a `FormElementWrapper` with the given form element, BO, and attribute.

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object other) Compares this `FormElementWrapper` to another object for ordering.
java.lang.String	describe() Generates a descriptive error message for a mandatory field.
java.lang.String	describeTheOnly() Generates a descriptive error message for a mandatory field, emphasizing that it's the only one.
AttributeI	getAttribute() Returns the associated attribute
BO	getBO() Returns the associated business object
FormElementWithDisplayPropertyI	getFormElement() Returns the wrapped form element

Methods inherited from class java.lang.Object

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

Constructor Detail

FormElementWrapper

public FormElementWrapper(FormElementWithDisplayPropertyI _fe,
                          BO _bo,
                          AttributeI _att)

Constructs a `FormElementWrapper` with the given form element, BO, and attribute.

Parameters:

_fe - The form element to wrap

_bo - The associated business object

_att - The associated attribute

Method Detail

describe

public java.lang.String describe()

Generates a descriptive error message for a mandatory field.

Returns:

A localized error message indicating that the attribute is mandatory

describeTheOnly

public java.lang.String describeTheOnly()

Generates a descriptive error message for a mandatory field, emphasizing that it's the only one.

Returns:

A localized error message indicating that the attribute is mandatory and the only one

getFormElement

public FormElementWithDisplayPropertyI getFormElement()

Returns the wrapped form element

Returns:

the wrapped form element

getBO

public BO getBO()

Returns the associated business object

Returns:

the associated business object

getAttribute

public AttributeI getAttribute()

Returns the associated attribute

Returns:

the associated attribute

compareTo

public int compareTo(java.lang.Object other)

Compares this `FormElementWrapper` to another object for ordering.

The comparison is based on the attribute names of the wrapped form elements.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

other - The object to be compared.

Returns:

A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - If the specified object's type prevents it from being compared to this object.