SecSuggestion.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SecSuggestion.java
 * Description: Interface for Suggestion and Alternative.
 */

/**
 * @file SecSuggestion.java
 *
 * @brief Interface for Suggestion and Alternative.
 */

package cz.vutbr.fit.knot.annotations.modules.suggestionManager.alternative;

import java.util.List;

/**
 * Interface for Suggestion and Alternative.
 *
 * @brief Interface for Suggestion and Alternative.
 * 
 * @author Marek Kopecký
 */
public interface SecSuggestion {
  
  /**
   * Gets list of suggested fragments
   *
   * @return Returns list of suggested fragments
   */
  public List getFragments();
  
  /**
   * Adds fragment to the list of suggested fragments
   *
   * @param fragment Suggested fragment
   */
  public void addSecFragment(SecFragment fragment);
  
  /**
   * Sets SEC API Entity Identifier
   * 
   * @param SAEntityIdentifier SEC API Entity Identifier
   */
  public void setSAEntityIdentifier(String SAEntityIdentifier);
  
}  // public interface SecSuggestion