I_CmsSetupXmlUpdate


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/setup/xml/I_CmsSetupXmlUpdate.java,v $
3    * Date   : $Date: 2006/03/27 14:52:44 $
4    * Version: $Revision: 1.2 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.setup.xml;
33  
34  import org.opencms.setup.CmsSetupBean;
35  
36  /**
37   * Represent a change to be applied to a xml file.<p>
38   * 
39   * @author Michael Moossen
40   * 
41   * @version $Revision: 1.2 $ 
42   * 
43   * @since 6.1.8 
44   */
45  public interface I_CmsSetupXmlUpdate {
46  
47      /**
48       * Execute the change.<p>
49       * 
50       * @param setupBean the setup bean
51       * 
52       * @throws Exception if something goes wrong 
53       */
54      void execute(CmsSetupBean setupBean) throws Exception  ;
55  
56      /**
57       * Returns the code to be added OR removed in the xml file.<p>
58       * 
59       * @param setupBean the setup bean
60       * 
61       * @return the code to be changed
62       * 
63       * @throws Exception if something goes wrong 
64       */
65      String   getCodeToChange(CmsSetupBean setupBean) throws Exception  ;
66  
67      /**
68       * Returns the nice name for the change.<p>
69       * 
70       * @return the nice name
71       */
72      String   getName();
73  
74      /**
75       * Returns the affected xml configuration file name.<p>
76       * 
77       * @return the xml file name
78       */
79      String   getXmlFilename();
80  
81      /**
82       * Validates the need to apply this change.<p>
83       * 
84       * @param setupBean the setup bean
85       * 
86       * @return <code>true</code> if needed
87       * 
88       * @throws Exception if something goes wrong 
89       */
90      boolean validate(CmsSetupBean setupBean) throws Exception  ;
91  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags