org.dspace.discovery.SolrServiceSearchPlugin 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
Show all versions of dspace-api Show documentation
DSpace core data model and service APIs.
/**
* 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 org.apache.solr.client.solrj.SolrQuery;
import org.dspace.core.Context;
/**
* Plugin from which users can add additional search parameters for every search that occurs in discovery
*
* @author Kevin Van de Velde (kevin at atmire dot com)
* @author Mark Diggory (markd at atmire dot com)
* @author Ben Bosman (ben at atmire dot com)
*/
public interface SolrServiceSearchPlugin {
/**
* Edits the solr query before it is sent to solr by adding additional parameters to it.
*
* @param context The DSpace Context object.
* @param discoveryQuery The discovery query object on which the solr query is based.
* @param solrQuery The query that will be sent to solr and which may be edited by this plugin.
* @throws SearchServiceException Any checked exception that might happen in this plugin
*/
public void additionalSearchParameters(Context context, DiscoverQuery discoveryQuery, SolrQuery solrQuery)
throws SearchServiceException;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy