org.dspace.harvest.service.HarvestedCollectionService 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.
The newest version!
/**
 * 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.harvest.service;

import java.sql.SQLException;
import java.util.List;

import org.dspace.content.Collection;
import org.dspace.core.Context;
import org.dspace.harvest.HarvestedCollection;

/**
 * Service interface class for the HarvestedCollection object.
 * The implementation of this class is responsible for all business logic calls for the HarvestedCollection object
 * and is autowired by spring
 *
 * @author kevinvandevelde at atmire.com
 */
public interface HarvestedCollectionService {

    /**
     * Find the harvest settings corresponding to this collection
     *
     * @param context    The relevant DSpace Context.
     * @param collection target collection
     * @return a HarvestInstance object corresponding to this collection's settings, null if not found.
     * @throws SQLException if database error
     */
    public HarvestedCollection find(Context context, Collection collection) throws SQLException;

    /**
     * Create a new harvest instance row for a specified collection.
     *
     * @param context    The relevant DSpace Context.
     * @param collection target collection
     * @return a new HarvestInstance object
     * @throws SQLException if database error
     */
    public HarvestedCollection create(Context context, Collection collection) throws SQLException;

    /**
     * Returns whether the specified collection is harvestable, i.e. whether its harvesting
     * options are set up correctly. This is distinct from "ready", since this collection may
     * be in process of being harvested.
     *
     * @param context    The relevant DSpace Context.
     * @param collection target collection
     * @return is collection harvestable?
     * @throws SQLException if database error
     */
    public boolean isHarvestable(Context context, Collection collection) throws SQLException;

    /**
     * Returns whether this harvest instance is actually harvestable, i.e. whether its settings
     * options are set up correctly. This is distinct from "ready", since this collection may
     * be in process of being harvested.
     *
     * @param harvestedCollection collection to be harvested
     * @return is collection harvestable?
     * @throws SQLException if database error
     */
    public boolean isHarvestable(HarvestedCollection harvestedCollection) throws SQLException;

    /**
     * Returns whether the specified collection is ready for immediate harvest.
     *
     * @param context    The relevant DSpace Context.
     * @param collection collection to be harvested
     * @return is collection ready for immediate harvest?
     * @throws SQLException if database error
     */
    public boolean isReady(Context context, Collection collection) throws SQLException;

    /**
     * Returns whether the specified collection is ready for immediate harvest.
     *
     * @param harvestedCollection collection to be harvested
     * @return is collection ready for immediate harvest?
     * @throws SQLException if database error
     */
    public boolean isReady(HarvestedCollection harvestedCollection) throws SQLException;

    /**
     * Find all collections that are set up for harvesting
     *
     * @param context The relevant DSpace Context.
     * @return list of collection id's
     * @throws SQLException if database error
     */
    public List findAll(Context context) throws SQLException;

    /**
     * Find all collections that are ready for harvesting
     *
     * @param context The relevant DSpace Context.
     * @return list of collection id's
     * @throws SQLException if database error
     */
    public List findReady(Context context) throws SQLException;

    /**
     * Find all collections with the specified status flag.
     *
     * @param context The relevant DSpace Context.
     * @param status  see HarvestInstance.STATUS_...
     * @return all collections with the specified status flag
     * @throws SQLException if database error
     */
    public List findByStatus(Context context, int status) throws SQLException;

    /**
     * Find the collection that was harvested the longest time ago.
     *
     * @param context The relevant DSpace Context.
     * @return collection that was harvested the longest time ago
     * @throws SQLException if database error
     */
    public HarvestedCollection findOldestHarvest(Context context) throws SQLException;


    /**
     * Find the collection that was harvested most recently.
     *
     * @param context The relevant DSpace Context.
     * @return collection that was harvested most recently
     * @throws SQLException if database error
     */
    public HarvestedCollection findNewestHarvest(Context context) throws SQLException;

    public void delete(Context context, HarvestedCollection harvestedCollection) throws SQLException;

    public void update(Context context, HarvestedCollection harvestedCollection) throws SQLException;

    public boolean exists(Context context) throws SQLException;

    /**
     * Test the given harvest settings
     * @param oaiSource  the address of the OAI-PMH provider
     * @param oaiSetId   OAI set identifier
     * @param metaPrefix OAI metadataPrefix
     * @param testORE    whether the method should also check the PMH provider for ORE support
     * @return list of errors encountered during verification. An empty list indicates a "success" condition.
     */
    public List verifyOAIharvester(String oaiSource,
                                           String oaiSetId, String metaPrefix, boolean testORE);
}