01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * 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: * getSkin - get skin name for separator
33: *
34: * @return skin name
35: */
36: String getSkin();
37:
38: /**
39: * setSkin - set skin name for separator
40: *
41: * @param name skin name
42: */
43: void setSkin(String name);
44:
45: /**
46: * getTitle - get default title for separator
47: *
48: * @return title text
49: */
50: String getTitle();
51:
52: /**
53: * setTitle - set default title for separator
54: *
55: * @param title title text
56: */
57: void setTitle(String title);
58:
59: /**
60: * getText - get default text for separator
61: *
62: * @return text
63: */
64: String getText();
65:
66: /**
67: * setText - set default text for separator
68: *
69: * @param text text
70: */
71: void setText(String text);
72:
73: /**
74: * getTitle - get locale specific title for separator from metadata
75: *
76: * @param locale preferred locale
77: * @return title text
78: */
79: String getTitle(Locale locale);
80:
81: /**
82: * getText - get locale specific text for separator from metadata
83: *
84: * @param locale preferred locale
85: * @return text
86: */
87: String getText(Locale locale);
88:
89: /**
90: * getMetadata - get generic metadata instance for menu
91: *
92: * @return metadata instance
93: */
94: GenericMetadata getMetadata();
95: }
|