View Javadoc

1   /*
2    * This file is a part of CAST project.
3    * (c) Copyright 2007, AGH University of Science & Technology
4    * https://caribou.iisg.agh.edu.pl/trac/cast
5    *
6    * Licensed under the Eclipse Public License, Version 1.0 (the "License").
7    * You may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    * http://www.eclipse.org/legal/epl-v10.html
10   */
11  /*
12   * File: IWizardPluginRegistryProvider.java
13   * Created: 2009-04-29
14   * Author: bmilos
15   * $Id$
16   */
17  
18  package pl.edu.agh.cast.importer.wizard.util;
19  
20  import org.eclipse.core.runtime.CoreException;
21  
22  import pl.edu.agh.cast.importer.wizard.dialog.analyzer.AbstractDataTypeConfigDialog;
23  import pl.edu.agh.cast.importer.wizard.dialog.rule.AbstractConversionRuleConfigDialog;
24  import pl.edu.agh.cast.importer.wizard.page.AbstractConversionRulesSelectionPage;
25  
26  /**
27   * Basic interface for the wizard implementation provider.
28   *
29   * @author AGH CAST Team
30   */
31  public interface IWizardPluginRegistryProvider {
32  
33  	/**
34  	 * Returns the conversion rules selection page for given page identifier.
35  	 *
36  	 * @param pageId
37  	 *            the id of conversion rules selection page
38  	 * @return the conversion rules selection page with given id
39  	 * @throws CoreException
40  	 */
41  	public AbstractConversionRulesSelectionPage getConversionRulesSelectionPageInstance(String pageId)
42  		throws CoreException;
43  
44  	/**
45  	 * Returns the conversion rule configuration dialog for given rule identifier.
46  	 *
47  	 * @param ruleId
48  	 *            the id of conversion rule
49  	 * @return the conversion rules configuration page for given rule id
50  	 * @throws CoreException
51  	 */
52  	public AbstractConversionRuleConfigDialog getConversionRuleConfigDialogInstance(String ruleId)
53  		throws CoreException;
54  
55  	/**
56  	 * Returns the data type configuration dialog for given data type identifier.
57  	 *
58  	 * @param dataTypeId
59  	 *            the id of data type
60  	 * @return the data type configuration page for given rule id
61  	 * @throws CoreException
62  	 */
63  	public AbstractDataTypeConfigDialog getDataTypeConfigDialogInstance(String dataTypeId) throws CoreException;
64  }