01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
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.shared.interfaces;
34:
35: import com.flexive.shared.configuration.Parameter;
36: import com.flexive.shared.exceptions.FxApplicationException;
37:
38: import javax.ejb.Remote;
39: import java.io.Serializable;
40:
41: /**
42: * Wrapper for accessing parameters transparently with their intrinsic scope.
43: *
44: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
45: */
46: @Remote
47: public interface ConfigurationEngine extends GenericConfigurationEngine {
48:
49: /**
50: * <p>Store the value in the source configuration EJB for the given parameter. For example, if
51: * a parameter in user scope has a division fallback and is not present for the calling user,
52: * the division configuration will be updated.</p>
53: * <p>Note that this may require higher privileges than for reading the given parameter,
54: * since a fallback configuration (division or global) may be used.</p>
55: *
56: * @param parameter the parameter to be checked
57: * @param key the key to be used
58: * @param value the value to be stored
59: * @throws com.flexive.shared.exceptions.FxApplicationException if the parameter value could not be updated
60: */
61: <T extends Serializable> void putInSource(Parameter<T> parameter,
62: String key, T value) throws FxApplicationException;
63:
64: /**
65: * <p>Store the value in the source configuration EJB for the given parameter. For example, if
66: * a parameter in user scope has a division fallback and is not present for the calling user,
67: * the division configuration will be updated.</p>
68: * <p>Note that this may require higher privileges than for reading the given parameter,
69: * since a fallback configuration (division or global) may be used.</p>
70: *
71: * @param parameter the parameter to be checked
72: * @param value the value to be stored
73: * @throws com.flexive.shared.exceptions.FxApplicationException if the parameter value could not be updated
74: */
75: <T extends Serializable> void putInSource(Parameter<T> parameter,
76: T value) throws FxApplicationException;
77: }
|