001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.jetspeed.om.folder;
018:
019: /**
020: * This interface describes the object used to define
021: * portal site menu options.
022: *
023: * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
024: * @version $Id: MenuOptionsDefinition.java 516448 2007-03-09 16:25:47Z ate $
025: */
026: public interface MenuOptionsDefinition {
027: /**
028: * ANY_PROFILE_LOCATOR - wildcard value for profile locator names
029: */
030: String ANY_PROFILE_LOCATOR = "*";
031:
032: /**
033: * getOptions - get comma separated menu options
034: *
035: * @return option paths specification
036: */
037: String getOptions();
038:
039: /**
040: * setOptions - set comma separated menu options
041: *
042: * @param options option paths specification
043: */
044: void setOptions(String options);
045:
046: /**
047: * getDepth - get depth of inclusion for folder options
048: *
049: * @return inclusion depth
050: */
051: int getDepth();
052:
053: /**
054: * setDepth - set depth of inclusion for folder options
055: *
056: * @param depth inclusion depth
057: */
058: void setDepth(int depth);
059:
060: /**
061: * isPaths - get generate ordered path options
062: *
063: * @return paths options flag
064: */
065: boolean isPaths();
066:
067: /**
068: * setPaths - set generate ordered path options
069: *
070: * @param paths paths options flag
071: */
072: void setPaths(boolean paths);
073:
074: /**
075: * isRegexp - get regexp flag for interpreting options
076: *
077: * @return regexp flag
078: */
079: boolean isRegexp();
080:
081: /**
082: * setRegexp - set regexp flag for interpreting options
083: *
084: * @param regexp regexp flag
085: */
086: void setRegexp(boolean regexp);
087:
088: /**
089: * getProfile - get profile locator used to filter options
090: *
091: * @return profile locator name
092: */
093: String getProfile();
094:
095: /**
096: * setProfile - set profile locator used to filter options
097: *
098: * @param locatorName profile locator name
099: */
100: void setProfile(String locatorName);
101:
102: /**
103: * getOrder - get comma separated regexp ordering patterns
104: *
105: * @return ordering patterns list
106: */
107: String getOrder();
108:
109: /**
110: * setOrder - set comma separated regexp ordering patterns
111: *
112: * @param order ordering patterns list
113: */
114: void setOrder(String order);
115:
116: /**
117: * getSkin - get skin name for options
118: *
119: * @return skin name
120: */
121: String getSkin();
122:
123: /**
124: * setSkin - set skin name for options
125: *
126: * @param name skin name
127: */
128: void setSkin(String name);
129: }
|