com.jgoodies.validation
Interface ValidationResultModel

All Known Implementing Classes:
AbstractValidationResultModel, DefaultValidationResultModel, DelayedValidationResultModel, LimitedValidationResultModel, ValidationResultModelContainer

public interface ValidationResultModel

Describes a model that holds a ValidationResult and provides bound read-only properties for the result, severity, error and messages state.

Since:
1.1
Version:
$Revision: 1.6 $
Author:
Karsten Lentzsch
See Also:
DefaultValidationResultModel

Field Summary
static String PROPERTYNAME_ERRORS
          The name of the bound property that indicates whether there are errors.
static String PROPERTYNAME_MESSAGES
          The name of the bound property that indicates whether there are messages.
static String PROPERTYNAME_RESULT
          The name of the bound property for the validation result.
static String PROPERTYNAME_SEVERITY
          The name of the bound property for the validation result severity.
 
Method Summary
 void addPropertyChangeListener(PropertyChangeListener listener)
          Adds a PropertyChangeListener to the listener list.
 void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Adds a PropertyChangeListener to the listener list for a specific property.
 PropertyChangeListener[] getPropertyChangeListeners()
          Returns an array of all the property change listeners registered on this component.
 PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
          Returns an array of all the listeners which have been associated with the named property.
 ValidationResult getResult()
          Returns this model's validation result which must be non-null.
 Severity getSeverity()
          Looks up and returns the Severity of this model's validation result, one of Severity.ERROR, Severity.WARNING, or Severity.OK.
 boolean hasErrors()
          Checks and answers whether this model's validation result has errors.
 boolean hasMessages()
          Checks and answers whether this model's validation result has messages.
 void removePropertyChangeListener(PropertyChangeListener listener)
          Removes a PropertyChangeListener from the listener list.
 void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
          Removes a PropertyChangeListener from the listener list for a specific property.
 void setResult(ValidationResult newResult)
          Sets a new non-null validation result and notifies all registered listeners, if the result changed.
 

Field Detail

PROPERTYNAME_RESULT

static final String PROPERTYNAME_RESULT
The name of the bound property for the validation result.

See Also:
getResult(), Constant Field Values

PROPERTYNAME_SEVERITY

static final String PROPERTYNAME_SEVERITY
The name of the bound property for the validation result severity.

See Also:
getSeverity(), Constant Field Values

PROPERTYNAME_ERRORS

static final String PROPERTYNAME_ERRORS
The name of the bound property that indicates whether there are errors.

See Also:
hasErrors(), Constant Field Values

PROPERTYNAME_MESSAGES

static final String PROPERTYNAME_MESSAGES
The name of the bound property that indicates whether there are messages.

See Also:
hasMessages(), Constant Field Values
Method Detail

getResult

ValidationResult getResult()
Returns this model's validation result which must be non-null.

Returns:
the current validation result
See Also:
setResult(ValidationResult)

setResult

void setResult(ValidationResult newResult)
Sets a new non-null validation result and notifies all registered listeners, if the result changed. This is typically invoked at the end of the #validate() method.

Implementors shall throw a NullPointerException if the new result is null.

Parameters:
newResult - the validation result to be set
See Also:
getResult()

getSeverity

Severity getSeverity()
Looks up and returns the Severity of this model's validation result, one of Severity.ERROR, Severity.WARNING, or Severity.OK.

Returns:
the severity of this model's validation result
See Also:
hasErrors(), hasMessages()

hasErrors

boolean hasErrors()
Checks and answers whether this model's validation result has errors.

Returns:
true if the validation result has errors, false otherwise
See Also:
getSeverity(), hasMessages()

hasMessages

boolean hasMessages()
Checks and answers whether this model's validation result has messages.

Returns:
true if the validation result has messages, false otherwise
See Also:
getSeverity(), hasErrors()

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list. The listener is registered for all bound properties of this class.

If listener is null, no exception is thrown and no action is performed.

Parameters:
listener - the PropertyChangeListener to be added
See Also:
removePropertyChangeListener(PropertyChangeListener), removePropertyChangeListener(String, PropertyChangeListener), addPropertyChangeListener(String, PropertyChangeListener), getPropertyChangeListeners()

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list. This method should be used to remove PropertyChangeListeners that were registered for all bound properties of this class.

If listener is null, no exception is thrown and no action is performed.

Parameters:
listener - the PropertyChangeListener to be removed
See Also:
addPropertyChangeListener(PropertyChangeListener), addPropertyChangeListener(String, PropertyChangeListener), removePropertyChangeListener(String, PropertyChangeListener), getPropertyChangeListeners()

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                               PropertyChangeListener listener)
Adds a PropertyChangeListener to the listener list for a specific property. The specified property may be user-defined.

Note that if this Model is inheriting a bound property, then no event will be fired in response to a change in the inherited property.

If listener is null, no exception is thrown and no action is performed.

Parameters:
propertyName - one of the property names listed above
listener - the PropertyChangeListener to be added
See Also:
removePropertyChangeListener(PropertyChangeListener), removePropertyChangeListener(String, PropertyChangeListener), addPropertyChangeListener(PropertyChangeListener), getPropertyChangeListeners(String)

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                  PropertyChangeListener listener)
Removes a PropertyChangeListener from the listener list for a specific property. This method should be used to remove PropertyChangeListeners that were registered for a specific bound property.

If listener is null, no exception is thrown and no action is performed.

Parameters:
propertyName - a valid property name
listener - the PropertyChangeListener to be removed
See Also:
addPropertyChangeListener(PropertyChangeListener), addPropertyChangeListener(String, PropertyChangeListener), removePropertyChangeListener(PropertyChangeListener), getPropertyChangeListeners(String)

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners()
Returns an array of all the property change listeners registered on this component.

Returns:
all of this component's PropertyChangeListeners or an empty array if no property change listeners are currently registered
See Also:
addPropertyChangeListener(PropertyChangeListener), removePropertyChangeListener(PropertyChangeListener), getPropertyChangeListeners(String), PropertyChangeSupport.getPropertyChangeListeners()

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
Returns an array of all the listeners which have been associated with the named property.

Parameters:
propertyName - the name of the property to lookup listeners
Returns:
all of the PropertyChangeListeners associated with the named property or an empty array if no listeners have been added
See Also:
addPropertyChangeListener(String, PropertyChangeListener), removePropertyChangeListener(String, PropertyChangeListener), getPropertyChangeListeners()


Copyright © 2003-2008 JGoodies Karsten Lentzsch. All Rights Reserved.