ch.uzh.ifi.attempto.acewiki.core
Interface SentenceSuggestion

All Known Implementing Classes:

AToEverySuggestion

public interface SentenceSuggestion

This interface represents a change suggestion for a newly created sentence. The user can decide whether to follow this suggestion or not. If the suggestion is followed, the sentence is automatically changed.

Author:

Tobias Kuhn

Method Summary

java.lang.String	getMessage() Returns the message to be presented to the user.
java.lang.String[]	getOptions() Returns the options given to the user to change or not change the sentence.
Sentence	getSentence(java.lang.String option) Returns the possibly changed sentence accoring to the option chosen by the user.

Method Detail

getMessage

java.lang.String getMessage()

Returns the message to be presented to the user. This message should explain the suggested change.

Returns:

The message text.

getOptions

java.lang.String[] getOptions()

Returns the options given to the user to change or not change the sentence.

Returns:

The options.

getSentence

Sentence getSentence(java.lang.String option)

Returns the possibly changed sentence accoring to the option chosen by the user.

Parameters:

option - The chosen option.

Returns:

The sentence, possibly changed.