com.okworx.ilcd.validation.reference.IDatasetReference 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.reference;

import com.okworx.ilcd.validation.common.DatasetType;

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

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

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

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

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

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

	/**
	 * getOrigin.
	 *
	 * This is the originating element in the dataset where the reference is stated.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public abstract String getOrigin();

	/**
	 * getOrigin.
	 *
	 * The UUID of the originating dataset where the reference is stated.
	 *
	 * @return a {@link java.lang.String} object.
	 */
	public abstract String getOriginDatasetUUID();

	public void setOriginDatasetUUID(String originDatasetUUID);

	/**
	 * equals.
	 *
	 * @param obj a {@link java.lang.Object} object.
	 * @return a boolean.
	 */
	public abstract boolean equals(Object obj);

	/**
	 * getType.
	 *
	 * @return a {@link com.okworx.ilcd.validation.common.DatasetType} object.
	 */
	public abstract DatasetType getDatasetType();

	/**
	 * setType.
	 *
	 * @param type a {@link com.okworx.ilcd.validation.common.DatasetType} object.
	 */
	public abstract void setDatasetType(DatasetType type);

	/**
	 * setName.
	 *
	 * @param name a {@link java.lang.String} object.
	 */
	public abstract void setName(String name);

}