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;
18  
19  import java.util.Locale;
20  
21  import org.apache.jetspeed.om.common.GenericMetadata;
22  
23  /***
24   * This interface describes the object used to define
25   * portal site menu separators.
26   * 
27   * @author <a href="mailto:rwatler@apache.org">Randy Watler</a>
28   * @version $Id: MenuSeparatorDefinition.java 516448 2007-03-09 16:25:47Z ate $
29   */
30  public interface MenuSeparatorDefinition
31  {
32      /***
33       * getSkin - get skin name for separator
34       *
35       * @return skin name
36       */
37      String getSkin();
38  
39      /***
40       * setSkin - set skin name for separator
41       *
42       * @param name skin name
43       */
44      void setSkin(String name);
45  
46      /***
47       * getTitle - get default title for separator
48       *
49       * @return title text
50       */
51      String getTitle();
52  
53      /***
54       * setTitle - set default title for separator
55       *
56       * @param title title text
57       */
58      void setTitle(String title);
59  
60      /***
61       * getText - get default text for separator
62       *
63       * @return text
64       */
65      String getText();
66  
67      /***
68       * setText - set default text for separator
69       *
70       * @param text text
71       */
72      void setText(String text);
73  
74      /***
75       * getTitle - get locale specific title for separator from metadata
76       *
77       * @param locale preferred locale
78       * @return title text
79       */
80      String getTitle(Locale locale);
81  
82      /***
83       * getText - get locale specific text for separator from metadata
84       *
85       * @param locale preferred locale
86       * @return text
87       */
88      String getText(Locale locale);
89  
90      /***
91       * getMetadata - get generic metadata instance for menu
92       *
93       * @return metadata instance
94       */
95      GenericMetadata getMetadata();
96  }