com.okworx.ilcd.validation.events.IValidationEvent 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.events;

import com.okworx.ilcd.validation.reference.IDatasetReference;

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

	/**
	 * getType.
	 *
	 * @return a {@link com.okworx.ilcd.validation.events.Type} object.
	 */
	public Type getType();

	/**
	 * getSeverity.
	 *
	 * @return a {@link com.okworx.ilcd.validation.events.Severity} object.
	 */
	public Severity getSeverity();

	/**
	 * getMessage.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getMessage();

	/**
	 * getAltMessage.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getAltMessage();

	/**
	 * getAspect.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getAspect();

	/**
	 * getAspectDescription.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String getAspectDescription();

	/**
	 * getReference.
	 *
	 * @return a {@link com.okworx.ilcd.validation.reference.IDatasetReference} object.
	 */
	public IDatasetReference getReference();

	/**
	 * setMessage.
	 *
	 * @param message a {@link java.lang.String} object.
	 */
	public void setMessage(String message);

	/**
	 * setAltMessage.
	 *
	 * @param message a {@link java.lang.String} object.
	 */
	public void setAltMessage(String message);

	/**
	 * setType.
	 *
	 * @param type a {@link com.okworx.ilcd.validation.events.Type} object.
	 */
	public void setType(Type type);

	/**
	 * setReference.
	 *
	 * @param reference a {@link com.okworx.ilcd.validation.reference.IDatasetReference} object.
	 */
	public void setReference(IDatasetReference reference);

	/**
	 * setSeverity.
	 *
	 * @param severity a {@link com.okworx.ilcd.validation.events.Severity} object.
	 */
	public void setSeverity(Severity severity);

	/**
	 * toString.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public String toString();

	/**
	 * getMessageReference.
	 *
	 * @return a {@link com.okworx.ilcd.validation.reference.IDatasetReference} object.
	 */
	public IDatasetReference getMessageReference();

	/**
	 * setMessageReference.
	 *
	 * @param reference a {@link com.okworx.ilcd.validation.reference.IDatasetReference} object.
	 */
	public void setMessageReference(IDatasetReference reference);

}