1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.apache.myfaces.orchestra.requestParameterProvider;
21
22 /***
23 * The interface a provider has to implement to add parameters to the url.
24 * <p>
25 * Objects which need to append parameters to all urls in the page being generated
26 * should create an implementation of this interface and register an object of that
27 * type with the RequestParameterProviderManager. When the page is generated the
28 * manager will call back to every registered RequestParameterProvider to get the
29 * data it needs to append.
30 */
31 public interface RequestParameterProvider
32 {
33 /***
34 * Return the names of fields this instance wants to add to the url. Each value in the
35 * returned array is then used as a parameter to the getFieldValue method.
36 */
37 public String[] getFields();
38
39 /***
40 * Return the value for the given field (which should be one of the values returned
41 * by the getFields method).
42 */
43 public String getFieldValue(String field);
44 }