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;
18
19 /***
20 * This interface describes the object used to define
21 * portal site menu included menus.
22 *
23 * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
24 * @version $Id: MenuIncludeDefinition.java 516448 2007-03-09 16:25:47Z ate $
25 */
26 public interface MenuIncludeDefinition
27 {
28 /***
29 * getName - get menu name to nest or with options to include
30 *
31 * @return menu name
32 */
33 String getName();
34
35 /***
36 * setName - set menu name to nest or with options to include
37 *
38 * @param name menu name
39 */
40 void setName(String name);
41
42 /***
43 * isNest - get nesting for included menu
44 *
45 * @return nest options flag
46 */
47 boolean isNest();
48
49 /***
50 * setNest - set nesting for included menu
51 *
52 * @param nest nest menu flag
53 */
54 void setNest(boolean nest);
55 }