01 /* This file is part of the project "Hilbert II" - http://www.qedeq.org
02 *
03 * Copyright 2000-2013, Michael Meyling <mime@qedeq.org>.
04 *
05 * "Hilbert II" is free software; you can redistribute
06 * it and/or modify it under the terms of the GNU General Public
07 * License as published by the Free Software Foundation; either
08 * version 2 of the License, or (at your option) any later version.
09 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 */
15
16 package org.qedeq.kernel.bo.common;
17
18
19 /**
20 * Represents a plugin execution.
21 *
22 * @author Michael Meyling
23 */
24 public interface PluginExecutor {
25
26 /**
27 * Execute plugin.
28 *
29 * @return Plugin specific resulting object. Might be <code>null</code>.
30 */
31 public Object executePlugin();
32
33 /**
34 * Get percentage of currently running plugin execution.
35 *
36 * @return Number between 0 and 100.
37 */
38 public double getExecutionPercentage();
39
40 /**
41 * Get description of currently taken action.
42 *
43 * @return We are doing this currently.
44 */
45 public String getLocationDescription();
46
47 }
|