View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  /* 
17  
18   */
19  
20  package org.apache.pluto.om.common;
21  
22  import java.util.Locale;
23  import java.util.ResourceBundle;
24  
25  /***
26   * <P>
27   * This interface provides access to a language and its attributes. 
28   * A language is defined in the portlet.xml of a portlet application archive
29   * file.
30   * </P>
31   * <P>
32   * This interface defines the model as known from the MVC pattern.
33   * Its purpose is to provide read access to the data stored in the model.
34   * </P>
35   * 
36  
37   */
38  public interface Language extends org.apache.pluto.om.Model
39  {
40  
41  
42      /***
43       * Returns the locale
44       * 
45       * @return the locale
46       */
47      public Locale getLocale();
48  
49      /***
50       * Returns the title
51       * 
52       * @return the title
53       */
54      public String getTitle();
55  
56      /***
57       * Returns the short title. The return value may be NULL.
58       * 
59       * @return the short title
60       */
61      public String getShortTitle();
62  
63      /***
64       * Returns the keywords
65       * 
66       * @return a readonly collection containg the keywords
67       */
68      public java.util.Iterator getKeywords();
69  
70      /***
71       * Returns the resource bundle for the portlet for the locale of the language     
72       * will be returned.     
73       * 
74       * @return a resource bundle
75       **/
76      public ResourceBundle getResourceBundle();
77  }