PluginBo.java
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.module;
17 
18 import org.qedeq.base.io.Parameters;
19 import org.qedeq.kernel.bo.common.PluginExecutor;
20 import org.qedeq.kernel.se.common.Plugin;
21 
22 
23 /**
24  * Represents a plugin and its services.
25  *
26  @author  Michael Meyling
27  */
28 public interface PluginBo extends Plugin {
29 
30     /**
31      * Create execution instance for this plugin.
32      *
33      @param   qedeq       QEDEQ module to work on.
34      @param   parameters  Plugin specific parameters. Might not be <code>null</code>.
35      @return  Instance to execute the plugin.
36      */
37     public PluginExecutor createExecutor(KernelQedeqBo qedeq, Parameters parameters);
38 
39     /**
40      * Set default configuration parameters.
41      *
42      @param   parameters  Plugin specific parameters. Non existing key value pairs will
43      *          be replaced by default values.
44      */
45     public void setDefaultValuesForEmptyPluginParameters(Parameters parameters);
46 
47 
48 }