01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2007
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.faces.beans;
34:
35: import com.flexive.shared.exceptions.FxApplicationException;
36:
37: /**
38: * <p>
39: * Beans that implement this interface allow to invoke (some of) their functionality
40: * by setting an "action" parameter in the HTTP request. Useful for invoking beans actions
41: * via javascript without a JSF command link. Note that it is not possible to control the
42: * resulting page forward with this method, the JSF page to be rendered has already
43: * been determined by the request URL.
44: * </p>
45: * <p>
46: * This is a workaround due to the frame-based architecture of the administration GUI.
47: * Usually you'd want to use more advanced concepts like managed properties or Seam
48: * page actions.
49: * </p>
50: *
51: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
52: * @version $Rev: 1 $
53: */
54: public interface ActionBean {
55: /**
56: * Parse the parameters and invoke any action that was requested.
57: * This method has to be accessed at the top of the JSF page that requested from
58: * the browser, e.g. via
59: * <code><c:if test="#{empty myActionBean.parseRequestParameters}"> </c:if></code>
60: *
61: * @return (irrelevant)
62: * @throws com.flexive.shared.exceptions.FxApplicationException
63: * if an application error occured. Note that
64: * throwing an exception here will display a top-level Facelets error page.
65: */
66: String getParseRequestParameters() throws FxApplicationException;
67: }
|