1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.rewriter.rules;
18
19 /***
20 * Rule
21 *
22 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
23 * @version $Id: Rule.java 516448 2007-03-09 16:25:47Z ate $
24 */
25 public interface Rule extends Identified
26 {
27 /***
28 * Flag indicating whether to use the Base URL for this rewriter.
29 * The default setting is true, use the rewriter's Base URL.
30 *
31 * @return true if this rule uses the Base URL
32 */
33 boolean getUseBase();
34
35 /***
36 * Flag indicating whether to use the Base URL for this rewriter.
37 * The default setting is true, use the rewriter's Base URL.
38 *
39 * @param true if this rule uses the Base URL
40 */
41 void setUseBase(boolean flag);
42
43 /***
44 * Suffix string to append to the rewritten URL.
45 *
46 * @return the value of the suffix string.
47 */
48 String getSuffix();
49
50 /***
51 * Suffix string to append to the rewritten URL.
52 *
53 * @param the value of the suffix string.
54 */
55 void setSuffix(String suffix);
56
57 /***
58 * Flag indicating whether to rewrite links as popups.
59 * The default setting is false, do not rewrite as a popup.
60 *
61 * @return true if this rule rewrites links as popups
62 */
63 boolean getPopup();
64
65 /***
66 * Flag indicating whether to rewrite links as popups.
67 * The default setting is false, do not rewrite as a popup.
68 *
69 * @param true if this rule rewrites links as popups
70 */
71 void setPopup(boolean flag);
72
73 /***
74 * Checks to see if a URL should be rewritten or not.
75 *
76 * @param url
77 */
78 boolean shouldRewrite(String url);
79
80
81
82 }