01: /*
02: * File : $Source: /usr/local/cvs/opencms/src/org/opencms/workplace/editors/I_CmsPreEditorActionDefinition.java,v $
03: * Date : $Date: 2008-02-27 12:05:23 $
04: * Version: $Revision: 1.4 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 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.editors;
33:
34: import org.opencms.file.CmsResource;
35: import org.opencms.file.types.I_CmsResourceType;
36: import org.opencms.workplace.CmsDialog;
37:
38: /**
39: * Defines an action to be performed before the workplace editor is opened for the first time.<p>
40: *
41: * @author Andreas Zahner
42: *
43: * @version $Revision: 1.4 $
44: *
45: * @since 6.5.4
46: */
47: public interface I_CmsPreEditorActionDefinition {
48:
49: /**
50: * Returns if an action has to be performed before opening the editor depending on the resource to edit
51: * and eventual request parameter values.<p>
52: *
53: * @param resource the resource to be edited
54: * @param dialog the dialog instance
55: * @param originalParams the original request parameters as String passed to the editor
56: * @return true if an action has to be performed before opening the editor
57: * @throws Exception if something goes wrong
58: */
59: boolean doPreAction(CmsResource resource, CmsDialog dialog,
60: String originalParams) throws Exception;
61:
62: /**
63: * Returns the resource type for which the action should be performed.<p>
64: *
65: * @return the resource type
66: */
67: I_CmsResourceType getResourceType();
68:
69: /**
70: * Returns the resource type name for which the action should be performed.<p>
71: *
72: * @return the resource type name
73: */
74: String getResourceTypeName();
75:
76: /**
77: * Sets the resource type name for which the action should be performed.<p>
78: *
79: * @param resourceTypeName the resource type name
80: */
81: void setResourceTypeName(String resourceTypeName);
82: }
|