org.dspace.discovery.IndexableObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dspace-api Show documentation

DSpace core data model and service APIs.

There is a newer version: 8.0

/**
 * The contents of this file are subject to the license and copyright
 * detailed in the LICENSE and NOTICE files at the root of the source
 * tree and available online at
 *
 * http://www.dspace.org/license/
 */
package org.dspace.discovery;

import java.io.Serializable;
import java.util.Date;

import org.dspace.core.Constants;
import org.dspace.core.ReloadableEntity;

/**
 * This is the basic interface that a data model entity need to implement to be indexable in Discover
 * 
 * @author Andrea Bollini (andrea.bollini at 4science.it)
 *
 * @param 
 *            the Class of the primary key
 */
public interface IndexableObject, PK extends Serializable> {

    /**
     * 
     * @return the string constant representing the Entity Type, @see {@link Constants}
     */
    String getType();

    /**
     * Return the identifier of this indexableObject, this will be the identifier of the object in the database
     * @return for a DSpaceObject a uuid will be returned, for a tasks or workflow items an integer will be returned
     */
    PK getID();

    /**
     * Get the entity that is linked to this indexable object
     * @return a database entity
     */
    T getIndexedObject();

    /**
     * Set the entity that is linked to this indexable object
     * @param object the database entity
     */
    void setIndexedObject(T object);

    /**
     * 
     * @return an unique id to index
     */
    default String getUniqueIndexID() {
        return getType() + "-" + getID().toString();
    }

    /**
     *
     * @return a textual alias of the Entity Type @see {@link #getType()}
     */
    String getTypeText();

    /**
     * Return the last modified date of an of an object, or if no modification dates are stored, return NUll
     * @return the last modified date
     */
    default Date getLastModified() {
        return null;
    }
}