com.okworx.ilcd.validation.IValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ilcd-validation Show documentation

A Java library for performing technical validation of data in ILCD data format.

There is a newer version: 2.7.2

package com.okworx.ilcd.validation;

import java.util.Map;

import com.okworx.ilcd.validation.events.EventsList;

/**
 * IValidator interface.
 *
 * @author oliver.kusche
 * @version $Id: $Id
 */
public interface IValidator {

	/**
	 * getAspectName.
	 *
	 * @return the name of the validation aspect covered by this Validator.
	 */
	public abstract String getAspectName();

	/**
	 * getAspectDescription.
	 *
	 * @return a description of the validation aspect covered by this Validator.
	 */
	public abstract String getAspectDescription();

	/**
	 * Invokes the validation
	 *
	 * @return the validation result
	 * @throws java.lang.InterruptedException if any.
	 */
	public boolean validate() throws InterruptedException;

	/**
	 * getEventsList.
	 *
	 * @return the list of validation events
	 */
	public EventsList getEventsList();

	/**
	 * setParameter.
	 *
	 * @param name a {@link java.lang.String} object.
	 * @param obj a {@link java.lang.Object} object.
	 */
	public void setParameter( String name, Object obj );

	/**
	 * Whether to report successful validations (default: false)
	 *
	 * @param reportSuccesses a boolean.
	 */
	public void setReportSuccesses(boolean reportSuccesses);

	public Map getParameters();
}