org.scohen.juploadr.prefs
Interface ConfigurationForm

All Known Implementing Classes:
BaseConfigurationForm, UploadActionForm

public interface ConfigurationForm

A Control for viewing and editing a sub-set of config settings. Each ConfigurationForm implementation is responsible for validating and persisting any changes made. This generic interface is intended to simplify the addition of new types of preferences, for example with plugins.

In addition to the methods in the interface, the contract of ConfigurationForm includes two additional requirements:

Author:
John

Method Summary
 void accountChanged()
           
 java.lang.String getFormName()
          Get a short name for the preferences this form class provides access to.
 void saveChanges()
          Save any changes made using the form.
 void setConfigurationDialog(ConfigurationDialog dialog)
           
 Fault validateChanges()
          Validate any changes made, returning an array of user-friendly error messages if there is a problem.
 

Method Detail

saveChanges

public void saveChanges()
Save any changes made using the form. If the form internally tracks whether changes have been made, this call may be a no-op.


validateChanges

public Fault validateChanges()
Validate any changes made, returning an array of user-friendly error messages if there is a problem. If validation passes, then returns null or an empty array.

Returns:

getFormName

public java.lang.String getFormName()
Get a short name for the preferences this form class provides access to.

Returns:
a short name for the preferences this form provides access to.

setConfigurationDialog

public void setConfigurationDialog(ConfigurationDialog dialog)

accountChanged

public void accountChanged()