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.impl;
018:
019: import org.apache.jetspeed.om.folder.MenuOptionsDefinition;
020:
021: /**
022: * This abstract class implements the menu options definition
023: * interface in a default manner to allow derived classes to
024: * easily describe standard menu definitions.
025: *
026: * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
027: * @version $Id: StandardMenuOptionsDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $
028: */
029: public abstract class StandardMenuOptionsDefinitionImpl implements
030: MenuOptionsDefinition {
031: /**
032: * StandardMenuOptionsDefinitionImpl - constructor
033: */
034: public StandardMenuOptionsDefinitionImpl() {
035: }
036:
037: /**
038: * getOptions - get comma separated menu options
039: *
040: * @return option paths specification
041: */
042: public String getOptions() {
043: return null;
044: }
045:
046: /**
047: * setOptions - set comma separated menu options
048: *
049: * @param options option paths specification
050: */
051: public void setOptions(String options) {
052: throw new RuntimeException(
053: "StandardMenuOptionsDefinitionImpl instance immutable");
054: }
055:
056: /**
057: * getDepth - get depth of inclusion for folder options
058: *
059: * @return inclusion depth
060: */
061: public int getDepth() {
062: return 0;
063: }
064:
065: /**
066: * setDepth - set depth of inclusion for folder options
067: *
068: * @param depth inclusion depth
069: */
070: public void setDepth(int depth) {
071: throw new RuntimeException(
072: "StandardMenuOptionsDefinitionImpl instance immutable");
073: }
074:
075: /**
076: * isPaths - get generate ordered path options
077: *
078: * @return paths options flag
079: */
080: public boolean isPaths() {
081: return false;
082: }
083:
084: /**
085: * setPaths - set generate ordered path options
086: *
087: * @param paths paths options flag
088: */
089: public void setPaths(boolean paths) {
090: throw new RuntimeException(
091: "StandardMenuOptionsDefinitionImpl instance immutable");
092: }
093:
094: /**
095: * isRegexp - get regexp flag for interpreting options
096: *
097: * @return regexp flag
098: */
099: public boolean isRegexp() {
100: return false;
101: }
102:
103: /**
104: * setRegexp - set regexp flag for interpreting options
105: *
106: * @param regexp regexp flag
107: */
108: public void setRegexp(boolean regexp) {
109: throw new RuntimeException(
110: "StandardMenuOptionsDefinitionImpl instance immutable");
111: }
112:
113: /**
114: * getProfile - get profile locator used to filter options
115: *
116: * @return profile locator name
117: */
118: public String getProfile() {
119: return null;
120: }
121:
122: /**
123: * setProfile - set profile locator used to filter options
124: *
125: * @param locatorName profile locator name
126: */
127: public void setProfile(String locatorName) {
128: throw new RuntimeException(
129: "StandardMenuOptionsDefinitionImpl instance immutable");
130: }
131:
132: /**
133: * getOrder - get comma separated regexp ordering patterns
134: *
135: * @return ordering patterns list
136: */
137: public String getOrder() {
138: return null;
139: }
140:
141: /**
142: * setOrder - set comma separated regexp ordering patterns
143: *
144: * @param order ordering patterns list
145: */
146: public void setOrder(String order) {
147: throw new RuntimeException(
148: "StandardMenuOptionsDefinitionImpl instance immutable");
149: }
150:
151: /**
152: * getSkin - get skin name for options
153: *
154: * @return skin name
155: */
156: public String getSkin() {
157: return null;
158: }
159:
160: /**
161: * setSkin - set skin name for options
162: *
163: * @param name skin name
164: */
165: public void setSkin(String name) {
166: throw new RuntimeException(
167: "StandardMenuOptionsDefinitionImpl instance immutable");
168: }
169: }
|