1 /*
2 * $Id: IVariableScopeCapability.java,v 1.1 2007/09/13 08:38:15 oeuillot Exp $
3 */
4 package org.rcfaces.core.internal.capability;
5
6
7 /**
8 * A couple string-binding specifying the name of a variable representing a
9 * shortcut to a binding. ex: if scopeVar "bat" is associated to scopeValue
10 * "bean.attribute1.attribute2" then the use of "bat.attribute3" will be
11 * equivalente to "bean.attribute1.attribute2.attribute3"
12 *
13 * @author Olivier Oeuillot (latest modification by $Author: oeuillot $)
14 * @version $Revision: 1.1 $ $Date: 2007/09/13 08:38:15 $
15 */
16 public interface IVariableScopeCapability {
17
18 /**
19 * Returns a string value specifying the name of a variable representing a
20 * shortcut to a binding.
21 *
22 * @return variable name
23 */
24 String getScopeVar();
25
26 /**
27 * Sets a string value specifying the name of a variable representing a
28 * shortcut to a binding.
29 *
30 * @param scopeVar
31 * variable name
32 */
33 void setScopeVar(String scopeVar);
34
35 /**
36 * Returns a value binding associated to a variable representing a shortcut.
37 *
38 * @return value binding
39 */
40 Object getScopeValue();
41
42 /**
43 * Sets a value binding associated to a variable representing a shortcut.
44 *
45 * @param valueBinding
46 * value binding
47 */
48 void setScopeValue(Object valueBinding);
49
50
51 /**
52 * Returns <code>true</code> if the value is stored when the view is serialized.
53 *
54 * @return <code>true</code> if the value is saved.
55 */
56 boolean isScopeSaveValue();
57
58 /**
59 * Sets if the value must be stored when the view is serialized.
60 *
61 * @param saveValue
62 */
63 void setScopeSaveValue(boolean saveValue);
64 }