org.valkyriercp.binding.validation.ValidationResultsModel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of valkyrie-rcp-core Show documentation

There is a newer version: 1.3

package org.valkyriercp.binding.validation;

import org.valkyriercp.core.PropertyChangePublisher;

/**
 * Adds the propertyChange and parent-child aspect to the
 * {@link ValidationResults} interface. Listeners can be registered on
 * validation changes of a specific property or on all changes. Additionally a
 * validationResultsModel has to be aware of its parent-child relationships to
 * forward these changes in its ValidationResults.
 *
 * @author Oliver Hutchison
 */
public interface ValidationResultsModel extends ValidationResults, PropertyChangePublisher {

	/** The name of the bound property hasErrors. */
	String HAS_ERRORS_PROPERTY = "hasErrors";

	/** The name of the bound property hasWarnings. */
	String HAS_WARNINGS_PROPERTY = "hasWarnings";

	/** The name of the bound property hasInfos. */
	String HAS_INFO_PROPERTY = "hasInfo";

	/**
	 * Adds a listener that will be notified when there is any change to the set
	 * of validation messages.
	 */
	void addValidationListener(ValidationListener listener);

	/**
	 * Removes the provided validation listener.
	 */
	void removeValidationListener(ValidationListener listener);

	/**
	 * Adds a listener that will be notified when there is any change to the set
	 * validation messages for the specified property.
	 */
	void addValidationListener(String propertyName, ValidationListener listener);

	/**
	 * Removes the provided validation listener.
	 */
	void removeValidationListener(String propertyName, ValidationListener listener);

	/**
	 * Add a validationResultsModel as a child to this one. Results originating
	 * from child models have to be taken into account by the parent.
	 *
	 * @param validationResultsModel
	 */
	void add(ValidationResultsModel validationResultsModel);

	/**
	 * Remove the given validationResultsModel from the list of children.
	 *
	 * @param validationResultsModel
	 */
	void remove(ValidationResultsModel validationResultsModel);
}