KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > main > I_CmsShellCommands


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src/org/opencms/main/I_CmsShellCommands.java,v $
3  * Date : $Date: 2005/06/23 11:11:38 $
4  * Version: $Revision: 1.8 $
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.main;
33
34 import org.opencms.file.CmsObject;
35
36 /**
37  * Provides scriptable access to a class from the CmsShell.<p>
38  *
39  * @author Alexander Kandzior
40  *
41  * @version $Revision: 1.8 $
42  *
43  * @version $Revision: 1.8 $
44  *
45  * @since 6.0.0
46  */
47 public interface I_CmsShellCommands {
48
49     /**
50      * Provides access to the shell CmsObject and the shell itself.<p>
51      *
52      * @param cms the shell CmsObject
53      * @param shell the CmsShell
54      */
55     void initShellCmsObject(CmsObject cms, CmsShell shell);
56
57     /**
58      * May be called after shell exit, can e.g. be used to ouput a goodbye message.<p>
59      *
60      * Please note: This method is not guaranteed to be called. For a shell that has more then
61      * one shell command object initialized, only the exit method of one of thouse will be called.<p>
62      */
63     void shellExit();
64
65     /**
66      * May be called before shell startup, can e.g. be used to ouput a welcome message.<p>
67      *
68      * Please note: This method is not guaranteed to be called. For a shell that has more then
69      * one shell command object initialized, only the start method of one of thouse will be called.<p>
70      */
71     void shellStart();
72
73 }
74
Popular Tags