1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.language;
24  
25  import java.util.Locale;
26  
27  import javax.portlet.PortletRequest;
28  
29  import javax.servlet.http.HttpServletRequest;
30  import javax.servlet.http.HttpServletResponse;
31  import javax.servlet.jsp.PageContext;
32  
33  /**
34   * <a href="Language.java.html"><b><i>View Source</i></b></a>
35   *
36   * @author Brian Wing Shun Chan
37   */
38  public interface Language {
39  
40      public String format(Locale locale, String pattern, Object argument);
41  
42      public String format(
43          Locale locale, String pattern, Object argument,
44          boolean translateArguments);
45  
46      public String format(Locale locale, String pattern, Object[] arguments);
47  
48      public String format(
49          Locale locale, String pattern, Object[] arguments,
50          boolean translateArguments);
51  
52      public String format(
53          PageContext pageContext, String pattern, LanguageWrapper argument);
54  
55      public String format(
56          PageContext pageContext, String pattern, LanguageWrapper argument,
57          boolean translateArguments);
58  
59      public String format(
60          PageContext pageContext, String pattern, LanguageWrapper[] arguments);
61  
62      public String format(
63          PageContext pageContext, String pattern, LanguageWrapper[] arguments,
64          boolean translateArguments);
65  
66      public String format(
67          PageContext pageContext, String pattern, Object argument);
68  
69      public String format(
70          PageContext pageContext, String pattern, Object argument,
71          boolean translateArguments);
72  
73      public String format(
74          PageContext pageContext, String pattern, Object[] arguments);
75  
76      public String format(
77          PageContext pageContext, String pattern, Object[] arguments,
78          boolean translateArguments);
79  
80      public String get(Locale locale, String key);
81  
82      public String get(Locale locale, String key, String defaultValue);
83  
84      public String get(PageContext pageContext, String key);
85  
86      public String get(PageContext pageContext, String key, String defaultValue);
87  
88      public Locale[] getAvailableLocales();
89  
90      public String getCharset(Locale locale);
91  
92      public String getLanguageId(HttpServletRequest request);
93  
94      public String getLanguageId(Locale locale);
95  
96      public String getLanguageId(PortletRequest portletRequest);
97  
98      public Locale getLocale(String languageCode);
99  
100     public String getTimeDescription(
101         PageContext pageContext, long milliseconds);
102 
103     public String getTimeDescription(
104         PageContext pageContext, Long milliseconds);
105 
106     public void init();
107 
108     public boolean isAvailableLocale(Locale locale);
109 
110     public boolean isDuplicateLanguageCode(String languageCode);
111 
112     public void resetAvailableLocales(long companyId);
113 
114     public void updateCookie(
115         HttpServletRequest request, HttpServletResponse response,
116         Locale locale);
117 
118 }