View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.om.folder.impl;
18  
19  import org.apache.jetspeed.om.folder.MenuIncludeDefinition;
20  
21  /***
22   * This interface describes the object used to define
23   * portal site menu included menus.
24   * 
25   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
26   * @version $Id: StandardMenuIncludeDefinitionImpl.java 516448 2007-03-09 16:25:47Z ate $
27   */
28  public abstract class StandardMenuIncludeDefinitionImpl implements MenuIncludeDefinition
29  {
30      /***
31       * StandardMenuIncludeDefinitionImpl - constructor
32       */
33      public StandardMenuIncludeDefinitionImpl()
34      {
35      }
36  
37      /***
38       * getName - get menu name to nest or with options to include
39       *
40       * @return menu name
41       */
42      public String getName()
43      {
44          return null;
45      }
46  
47      /***
48       * setName - set menu name to nest or with options to include
49       *
50       * @param name menu name
51       */
52      public void setName(String name)
53      {
54          throw new RuntimeException("StandardMenuIncludeDefinitionImpl instance immutable");
55      }
56  
57      /***
58       * isNest - get nesting for included menu
59       *
60       * @return nest options flag
61       */
62      public boolean isNest()
63      {
64          return false;
65      }
66      
67      /***
68       * setNest - set nesting for included menu
69       *
70       * @param nest nest menu flag
71       */
72      public void setNest(boolean nest)
73      {
74          throw new RuntimeException("StandardMenuIncludeDefinitionImpl instance immutable");
75      }
76  }