1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

/**
 * 
 */
package com.googlecode.pennybank.swing.controller.actions;

/**
 * This interface defines the methods needed to implement the Command Pattern.
 * It defines methods for executing, undoing, redoing the action, and obtaining
 * the action name.
 * 
 * @author spenap
 */
public interface UIAction {

	/**
	 * Enumerate defining the different outputs from an action
	 * 
	 * @author spenap
	 */
	public enum ActionResult {
		SUCCESS, FAIL
	}

	/**
	 * This method allows the execution of the action.
	 */
	public boolean execute();

	/**
	 * This method allows undoing the action
	 */
	public void undo();

	/**
	 * This method allows redoing the action
	 */
	public void redo();

	/**
	 * This method allows obtaining the action name, which will be used as its
	 * description in the user interface
	 * 
	 * @return The string representing the action name
	 */
	public String getName();
}