org.formproc
Interface FormConfiguration

All Known Implementing Classes:
AbstractFormConfiguration

public interface FormConfiguration

Standard interface for configuration information for a single Form.

Author:
Anthony Eden

Method Summary
 FormElement getFormElement(java.lang.String name)
          Get the named FormElement.
 FormElementGroup getFormElementGroup(java.lang.String name)
          Get the named FormElementGroup.
 java.util.List getFormElementGroups()
          Return a non-mutable List of FormElementGroup objects in the same order as they appear in the form's configuration.
 java.util.List getFormElements()
          Return a non-mutable List of FormElements in the same order as they appear in the form's configuration.
 java.lang.String getName()
          Get the form name.
 Storer getStorer()
          Get the default Storer.
 TypeConverter getTypeConverter()
          Get the default TypeConverter.
 Validator getValidator()
          Get the default Validator.
 boolean isConvertNullValues()
          Return true to convert null values.
 boolean isSkipNullValues()
          Return true to skip validation, conversion and storage of null values.
 boolean isStoreNullValues()
          Return true to store null values.
 boolean isValidateNullValues()
          Return true to validate null values.
 

Method Detail

getName

public java.lang.String getName()
Get the form name.

Returns:
The form name

getValidator

public Validator getValidator()
Get the default Validator. This method may be null if no default Validator is specified in the form configuration.

Returns:
The Validator or null

getTypeConverter

public TypeConverter getTypeConverter()
Get the default TypeConverter. This method may be null if no default TypeConverter is specified in the form configuration.

Returns:
The TypeConverter or null

getStorer

public Storer getStorer()
Get the default Storer. This method may return null if no default Storer is specified in the form configuration.

Returns:
The Storer or null

getFormElement

public FormElement getFormElement(java.lang.String name)
Get the named FormElement. If no FormElement for the given name exists then this method returns null.

Parameters:
name - The form element name
Returns:
The FormElement

getFormElementGroup

public FormElementGroup getFormElementGroup(java.lang.String name)
Get the named FormElementGroup. If no FormElementGroup for the given name exists then this method returns null.

Parameters:
name - The form element group name
Returns:
The FormElementGroup

getFormElements

public java.util.List getFormElements()
Return a non-mutable List of FormElements in the same order as they appear in the form's configuration.

Returns:
A non-mutable List of FormElement objects

getFormElementGroups

public java.util.List getFormElementGroups()
Return a non-mutable List of FormElementGroup objects in the same order as they appear in the form's configuration.

Returns:
A non-mutable List of FormElementGroup objects

isSkipNullValues

public boolean isSkipNullValues()
Return true to skip validation, conversion and storage of null values.

Returns:
True to skip null values

isValidateNullValues

public boolean isValidateNullValues()
Return true to validate null values.

Returns:
True to validate null values

isConvertNullValues

public boolean isConvertNullValues()
Return true to convert null values.

Returns:
True to convert null values

isStoreNullValues

public boolean isStoreNullValues()
Return true to store null values.

Returns:
True to store null values


Copyright (c) 2001-2003 Anthony Eden. All Rights Reserved.