 | Report generated by Clover Code Coverage v3.1.10 Fri May 24 2013 13:47:32 UTC. |
Clover: Open Source License registered to qedeq.org . |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PluginExecutor | Line # 28 | 0 | 0 | - |
-1.0
|
||||||||||||||||||||||||||||||||||||||||||||||||||||
| No Tests | |||
| 1 | /* This file is part of the project "Hilbert II" - http://www.qedeq.org | |
| 2 | * | |
| 3 | * Copyright 2000-2013, Michael Meyling <mime@qedeq.org>. | |
| 4 | * | |
| 5 | * "Hilbert II" is free software; you can redistribute | |
| 6 | * it and/or modify it under the terms of the GNU General Public | |
| 7 | * License as published by the Free Software Foundation; either | |
| 8 | * version 2 of the License, or (at your option) any later version. | |
| 9 | * | |
| 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.module; | |
| 17 | ||
| 18 | import org.qedeq.kernel.se.common.ServiceCompleteness; | |
| 19 | import org.qedeq.kernel.se.visitor.InterruptException; | |
| 20 | ||
| 21 | ||
| 22 | ||
| 23 | /** | |
| 24 | * Represents a plugin execution. | |
| 25 | * | |
| 26 | * @author Michael Meyling | |
| 27 | */ | |
| 28 | public interface PluginExecutor extends ServiceCompleteness { | |
| 29 | ||
| 30 | /** | |
| 31 | * Execute plugin. | |
| 32 | * | |
| 33 | * @param call Service call. | |
| 34 | * @param data Process execution data. | |
| 35 | * @return Plugin specific resulting object. Might be <code>null</code>. | |
| 36 | * @throws InterruptException User canceled execution. | |
| 37 | */ | |
| 38 | public Object executePlugin(final InternalServiceCall call, final Object data) throws InterruptException; | |
| 39 | ||
| 40 | /** | |
| 41 | * Get percentage of currently running plugin execution. | |
| 42 | * | |
| 43 | * @return Number between 0 and 100. | |
| 44 | */ | |
| 45 | public double getVisitPercentage(); | |
| 46 | ||
| 47 | /** | |
| 48 | * Get description of currently taken action. | |
| 49 | * | |
| 50 | * @return We are doing this currently. | |
| 51 | */ | |
| 52 | public String getLocationDescription(); | |
| 53 | ||
| 54 | /** | |
| 55 | * Was the execution interrupted by the user? | |
| 56 | * | |
| 57 | * @return The execution was interrupted. | |
| 58 | */ | |
| 59 | public boolean getInterrupted(); | |
| 60 | ||
| 61 | } | |
|
||||||||||