KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > opencms > workplace > tools > content > check > A_CmsContentCheck


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/content/check/A_CmsContentCheck.java,v $
3  * Date : $Date: 2006/03/27 14:52:54 $
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.workplace.tools.content.check;
33
34 import org.opencms.file.CmsObject;
35 import org.opencms.main.CmsException;
36 import org.opencms.workplace.CmsDialog;
37 import org.opencms.workplace.CmsWorkplace;
38 import org.opencms.workplace.tools.CmsToolManager;
39 import org.opencms.workplace.tools.CmsToolRootHandler;
40 import org.opencms.workplace.tools.I_CmsToolHandler;
41
42 import java.util.HashMap JavaDoc;
43 import java.util.List JavaDoc;
44 import java.util.Map JavaDoc;
45
46 /**
47  * Abstract class for a CmsContentCheck.<p>
48  *
49  * @author Michael Emmerich
50  *
51  * @version $Revision: 1.2 $
52  *
53  * @since 6.1.2
54  */

55 public abstract class A_CmsContentCheck implements I_CmsContentCheck, I_CmsToolHandler {
56
57     /** Closelink path. */
58     private static final String JavaDoc CLOSELINK = "/contenttools/checkconfig";
59
60     /**
61      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#executeContentCheck(org.opencms.file.CmsObject, org.opencms.workplace.tools.content.check.CmsContentCheckResource)
62      */

63     public abstract CmsContentCheckResource executeContentCheck(CmsObject cms, CmsContentCheckResource testResource)
64     throws CmsException;
65
66     /**
67      * @see org.opencms.workplace.tools.I_CmsToolHandler#getConfirmationMessage()
68      */

69     public String JavaDoc getConfirmationMessage() {
70
71         return null;
72     }
73
74     /**
75      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#getDialogParameterName()
76      */

77     public abstract String JavaDoc getDialogParameterName();
78
79     /**
80      * @see org.opencms.workplace.tools.I_CmsToolHandler#getDisabledHelpText()
81      */

82     public String JavaDoc getDisabledHelpText() {
83
84         return null;
85     }
86
87     /**
88      * @see org.opencms.workplace.tools.I_CmsToolHandler#getGroup()
89      */

90     public String JavaDoc getGroup() {
91
92         return org.opencms.workplace.tools.content.Messages.get().getBundle().key(
93             org.opencms.workplace.tools.content.Messages.GUI_CHECKCONTENT_CONFIGURATION_ADMIN_TOOL_NAME_0);
94     }
95
96     /**
97      * @see org.opencms.workplace.tools.I_CmsToolHandler#getHelpText()
98      */

99     public abstract String JavaDoc getHelpText();
100
101     /**
102      * @see org.opencms.workplace.tools.I_CmsToolHandler#getIconPath()
103      */

104     public abstract String JavaDoc getIconPath();
105
106     /**
107      * @see org.opencms.workplace.tools.I_CmsToolHandler#getLink()
108      */

109
110     public abstract String JavaDoc getLink();
111
112     /**
113      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#getMessageBundles()
114      */

115     public abstract List JavaDoc getMessageBundles();
116
117     /**
118      * @see org.opencms.workplace.tools.I_CmsToolHandler#getName()
119      */

120     public abstract String JavaDoc getName();
121
122     /**
123      * @see org.opencms.workplace.tools.I_CmsToolHandler#getParameters(org.opencms.workplace.CmsWorkplace)
124      */

125     public Map JavaDoc getParameters(CmsWorkplace wp) {
126
127         Map JavaDoc parameters = new HashMap JavaDoc();
128         parameters.put(CmsDialog.PARAM_CLOSELINK, CmsToolManager.linkForToolPath(wp.getJsp(), CLOSELINK));
129
130         return parameters;
131     }
132
133     /**
134      * @see org.opencms.workplace.tools.I_CmsToolHandler#getPath()
135      */

136     public abstract String JavaDoc getPath();
137
138     /**
139      * @see org.opencms.workplace.tools.I_CmsToolHandler#getPosition()
140      */

141     public abstract float getPosition();
142
143     /**
144      * @see org.opencms.workplace.tools.I_CmsToolHandler#getShortName()
145      */

146     public abstract String JavaDoc getShortName();
147
148     /**
149      * @see org.opencms.workplace.tools.I_CmsToolHandler#getSmallIconPath()
150      */

151     public String JavaDoc getSmallIconPath() {
152
153         return null;
154     }
155
156     /**
157      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#init(org.opencms.file.CmsObject)
158      */

159     public abstract void init(CmsObject cms) throws CmsException;
160
161     /**
162      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#isActive()
163      */

164     public abstract boolean isActive();
165
166     /**
167      * @see org.opencms.workplace.tools.I_CmsToolHandler#isEnabled(org.opencms.file.CmsObject)
168      */

169     public boolean isEnabled(CmsObject cms) {
170
171         return true;
172     }
173
174     /**
175      * @see org.opencms.workplace.tools.I_CmsToolHandler#isVisible(org.opencms.file.CmsObject)
176      */

177     public boolean isVisible(CmsObject cms) {
178
179         return true;
180     }
181
182     /**
183      * @see org.opencms.workplace.tools.content.check.I_CmsContentCheck#setActive(boolean)
184      */

185     public abstract void setActive(boolean value);
186
187     /**
188      * @see org.opencms.workplace.tools.I_CmsToolHandler#setup(org.opencms.file.CmsObject, org.opencms.workplace.tools.CmsToolRootHandler, java.lang.String)
189      */

190     public boolean setup(CmsObject cms, CmsToolRootHandler root, String JavaDoc resourcePath) {
191
192         return true;
193     }
194 }
195
Popular Tags