01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/util/tags/sakai_2-4-1/util-api/api/src/java/org/sakaiproject/i18n/InternationalizedMessages.java $
03: * $Id: InternationalizedMessages.java 18135 2006-11-14 19:13:18Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.i18n;
21:
22: import java.util.Locale;
23: import java.util.Map;
24:
25: /**
26: * InternationalizedMessages is a bundle of message implementations for many locales.
27: */
28: public interface InternationalizedMessages extends Map {
29: /** The type string for this "application": should not change over time as it may be stored in various parts of persistent entities. */
30: String APPLICATION_ID = "sakai:resourceloader";
31:
32: /** Preferences key for user's regional language locale */
33: String LOCALE_KEY = "locale";
34:
35: /**
36: * Return formatted message based on locale-specific pattern
37: *
38: * @param key
39: * maps to locale-specific pattern in properties file
40: * @param args
41: * parameters to format and insert according to above pattern
42: * @return formatted message
43: */
44: String getFormattedMessage(String key, Object[] args);
45:
46: /**
47: * Return user's prefered locale
48: *
49: * @return user's Locale object
50: */
51: Locale getLocale();
52:
53: /**
54: * Return string value for specified property in current locale specific ResourceBundle
55: *
56: * @param key
57: * property key to look up in current ResourceBundle * *
58: * @return String value for specified property key
59: */
60: String getString(String key);
61:
62: /**
63: * Return string value for specified property in current locale specific ResourceBundle
64: *
65: * @param key
66: * property key to look up in current ResourceBundle
67: * @param dflt
68: * the default value to be returned in case the property is missing
69: * @return String value for specified property key
70: */
71: String getString(String key, String dflt);
72: }
|