1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.jetspeed.om.folder;
18
19 /***
20 * This interface describes the object used to define
21 * portal site menu options.
22 *
23 * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
24 * @version $Id: MenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $
25 */
26 public interface MenuOptionsDefinition
27 {
28 /***
29 * ANY_PROFILE_LOCATOR - wildcard value for profile locator names
30 */
31 String ANY_PROFILE_LOCATOR = "*";
32
33 /***
34 * getOptions - get comma separated menu options
35 *
36 * @return option paths specification
37 */
38 String getOptions();
39
40 /***
41 * setOptions - set comma separated menu options
42 *
43 * @param options option paths specification
44 */
45 void setOptions(String options);
46
47 /***
48 * getDepth - get depth of inclusion for folder options
49 *
50 * @return inclusion depth
51 */
52 int getDepth();
53
54 /***
55 * setDepth - set depth of inclusion for folder options
56 *
57 * @param depth inclusion depth
58 */
59 void setDepth(int depth);
60
61 /***
62 * isPaths - get generate ordered path options
63 *
64 * @return paths options flag
65 */
66 boolean isPaths();
67
68 /***
69 * setPaths - set generate ordered path options
70 *
71 * @param paths paths options flag
72 */
73 void setPaths(boolean paths);
74
75 /***
76 * isRegexp - get regexp flag for interpreting options
77 *
78 * @return regexp flag
79 */
80 boolean isRegexp();
81
82 /***
83 * setRegexp - set regexp flag for interpreting options
84 *
85 * @param regexp regexp flag
86 */
87 void setRegexp(boolean regexp);
88
89 /***
90 * getProfile - get profile locator used to filter options
91 *
92 * @return profile locator name
93 */
94 String getProfile();
95
96 /***
97 * setProfile - set profile locator used to filter options
98 *
99 * @param locatorName profile locator name
100 */
101 void setProfile(String locatorName);
102
103 /***
104 * getOrder - get comma separated regexp ordering patterns
105 *
106 * @return ordering patterns list
107 */
108 String getOrder();
109
110 /***
111 * setOrder - set comma separated regexp ordering patterns
112 *
113 * @param order ordering patterns list
114 */
115 void setOrder(String order);
116
117 /***
118 * getSkin - get skin name for options
119 *
120 * @return skin name
121 */
122 String getSkin();
123
124 /***
125 * setSkin - set skin name for options
126 *
127 * @param name skin name
128 */
129 void setSkin(String name);
130 }