taverna-workbench-perspective-biocatalogue/src/main/java/net/sf/taverna/biocatalogue/model/search/SearchInstanceTracker.java

package net.sf.taverna.biocatalogue.model.search;

import net.sf.taverna.biocatalogue.model.Resource;

/**
 * Implementations of this interface will keep track of
 * current search instances for different resource types
 * (under assumption that {@link SearchInstance} classes
 * can only deal with one resource type per instance).
 * 
 * In the BioCatalogue plugin it is one of the UI components
 * that needs to keep track of active search instances. This
 * interface helps to decouple the search engine model from the
 * UI.
 * 
 * @author Sergejs Aleksejevs
 */
public interface SearchInstanceTracker
{
  /**
   * Clears all records of previous search instances.
   */
  public void clearPreviousSearchInstances();
  
  /**
   * Registers an instance of {@link SearchInstance} class
   * as a current one for a specific resource type.
   * 
   * Repeated calls to this method with the same parameter
   * should overwrite old values.
   * 
   * @param searchType Resource type to associate the registered
   *                   {@link SearchInstance} with.
   */
  public void registerSearchInstance(Resource.TYPE searchType, SearchInstance searchInstance);
  
  
  /**
   * Tests if provided {@link SearchInstance} is registered as the
   * current one.
   * 
   * @param searchType Resource type to perform the test for.
   * @param searchInstance {@link SearchInstance} object that is expected to be
   *                       the current search instance for the specified resource type.
   * @return <code>true</code> - if the provided <code>searchInstance</code> is indeed
   *                       currently registered as the active one for the given resouce type;<br/>
   *         <code>false</code> - otherwise.
   */
  public boolean isCurrentSearchInstance(Resource.TYPE searchType, SearchInstance searchInstance);
  
  
  /**
   * @param searchType
   * @return Currently active {@link SearchInstance} object for the specified resource type.
   */
  public SearchInstance getCurrentSearchInstance(Resource.TYPE searchType);
}