KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > setup > dl > DataLoader


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/
9 package org.jboss.portal.setup.dl;
10
11 import org.jboss.portal.setup.PortalSetupException;
12 import org.w3c.dom.Element JavaDoc;
13
14
15 /**
16  * @author palber; Date: Apr 7, 2005; Time: 4:43:23 PM
17  * @since Spitfire
18  * Interface org.jboss.portal.setup.dl.DataLoader is an abstraction of DataLoader service.
19  * Provides ability to load, alter, update data, dbloader schema
20  */
21 public interface DataLoader
22 {
23
24    /**
25     * @return Data loader configuration
26     */
27    DataLoaderConfig getDataLoaderConfiguration();
28
29    /**
30     * @param congig a DataLoaderConfig
31     */
32    void setDataLoaderConfiguration(DataLoaderConfig congig) throws PortalSetupException;
33
34
35    /**
36     * st
37     *
38     * @return
39     */
40    boolean loadData(Element JavaDoc action) throws PortalSetupException;
41
42
43    /**
44     * destroy DataLoader and cleans all resources
45     *
46     * @throws PortalSetupException
47     */
48    void destroy() throws PortalSetupException;
49
50    /**
51     * @return boolean flag; when true means that database data have been initialized
52     * @throws PortalSetupException in case of an error: database schema have not been loaded,
53     * cannot connect to database instance, etc.
54     */
55    boolean checkDataInitialized() throws PortalSetupException;
56
57
58 }
59
Popular Tags