001    // This file is part of AceWiki.
002    // Copyright 2008-2012, AceWiki developers.
003    // 
004    // AceWiki is free software: you can redistribute it and/or modify it under the terms of the GNU
005    // Lesser General Public License as published by the Free Software Foundation, either version 3 of
006    // the License, or (at your option) any later version.
007    // 
008    // AceWiki is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
009    // even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
010    // Lesser General Public License for more details.
011    // 
012    // You should have received a copy of the GNU Lesser General Public License along with AceWiki. If
013    // not, see http://www.gnu.org/licenses/.
014    
015    package ch.uzh.ifi.attempto.acewiki.core;
016    
017    /**
018     * This interface represents a change suggestion for a newly created sentence. The user can decide
019     * whether to follow this suggestion or not. If the suggestion is followed, the sentence is
020     * automatically changed.
021     * 
022     * @author Tobias Kuhn
023     */
024    public interface SentenceSuggestion {
025            
026            /**
027             * Returns the message to be presented to the user. This message should explain the suggested
028             * change.
029             * 
030             * @return The message text.
031             */
032            public String getMessage();
033            
034            /**
035             * Returns the options given to the user to change or not change the sentence.
036             * 
037             * @return The options.
038             */
039            public String[] getOptions();
040            
041            /**
042             * Returns the possibly changed sentence accoring to the option chosen by the user.
043             * 
044             * @param option The chosen option.
045             * @return The sentence, possibly changed.
046             */
047            public Sentence getSentence(String option);
048    
049    }