KickJava   Java API By Example, From Geeks To Geeks.

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


1 /*
2  * File : $Source: /usr/local/cvs/opencms/src-modules/org/opencms/workplace/tools/content/check/I_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
37 import java.util.List JavaDoc;
38
39 /**
40  * This interface defines an OpenCms content check. A content check will
41  * test the content of the properties of all resources inside of OpenCms if they
42  * follow the rules which are defined inside the test implemnting this interface.<p>
43  *
44  * @author Michael Emmerich
45  *
46  * @version $Revision: 1.2 $
47  *
48  * @since 6.1.2
49  */
50
51 public interface I_CmsContentCheck {
52
53     /** Parameter name for widgets. */
54     String JavaDoc PARAMETER = "active";
55
56     /**
57      * Main method of the content check. It holds the implementation of the content check.<p>
58      *
59      * @param cms the CmsObject
60      * @param testResource a CmsContentTestResource containing the results of previous tests
61      * @return the updated testResouce containing the results of the content check
62      * @throws CmsException if an error occurs
63      */
64     CmsContentCheckResource executeContentCheck(CmsObject cms, CmsContentCheckResource testResource)
65     throws CmsException;
66
67     /**
68      * Defines the name of the parameter which is used by the CmsContentCheckDialog to enable
69      * or disable the content check.<p>
70      *
71      * @return the name of the dialog parameter.
72      */
73     String JavaDoc getDialogParameterName();
74
75     /**
76      * Gets a list of all required message bundles by this content check.<p>
77      *
78      * @return list of message bundle names
79      */
80     List JavaDoc getMessageBundles();
81
82     /**
83      * Gets the name of this content check.<p>
84      *
85      * @return name of the content check
86      */
87     String JavaDoc getName();
88
89     /**
90      * Initializer for the content check.<p>
91      *
92      * @param cms the current CmsObject
93      * @throws CmsException if an error occurs
94      */
95     void init(CmsObject cms) throws CmsException;
96
97     /**
98      * Signals if this content check is active or not.<p>
99      *
100      *
101      * @return true if this content check is active, false otherwise.
102      */
103     boolean isActive();
104
105     /**
106      * Sets the active flag for the content check.<p>
107      *
108      * @param value the value for the active flag
109      */
110     void setActive(boolean value);
111
112 }
113
Popular Tags