View Javadoc

1   package at.ac.tuwien.ifs.bpse.basic.export_import;
2   
3   import java.io.IOException;
4   import java.util.List;
5   
6   import at.ac.tuwien.ifs.bpse.basic.domain.Student;
7   
8   /**
9    * This Interface specifies methods for importing Students.
10   * 
11   * @author The SE-Team
12   * @version 1.0
13   */
14  public interface Import {
15  
16  	/**
17  	 * Loads the Students from the given file. The expected file-structure is
18  	 * determined by the implementing class.
19  	 * 
20  	 * @param filename
21  	 *            The file to read from.
22  	 * @return A List of Stundents retrieved from the file.
23  	 * @throws IOException
24  	 *             on any IOException.
25  	 */
26  	public List<Student> read(String filename) throws IOException;
27  
28  	/**
29  	 * Returns the used file-extension. This method is required to give the GUI
30  	 * components Feedback which File extension this Export Type creates.
31  	 * 
32  	 * @return file-extension, eg. <code>.xml</code>
33  	 */
34  	public String getExtension();
35  
36  }