View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation 
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the
5    * "License"); you may not use this file except in compliance with the
6    * License. You may obtain a copy of the License at
7    *
8    * http://www.osedu.org/licenses/ECL-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
13   * implied. See the License for the specific language governing
14   * permissions and limitations under the License.
15   */
16  
17  package org.kuali.student.r2.common.infc;
18  
19  import javax.xml.bind.annotation.XmlElement;
20  
21  /**
22   * A common data structure for holding locale information.
23   *
24   * @Version 2.0
25   * @Author Sri komandur@uw.edu
26   */
27  
28  public interface Locale {
29  
30      /**
31       * The language portion of the locale information used in this
32       * context.
33       *
34       * @name Locale Language
35       */
36      public String getLocaleLanguage();
37  
38      /**
39       * The language variant portion of the locale information to be
40       * used in this context .
41       *
42       * @name Locale Language Variant
43       */
44      public String getLocaleVariant();
45  
46      /**
47       * The language Region portion of the locale information to be
48       * used in this context.
49       *
50       * @name Locale Region
51       */
52      public String getLocaleRegion();
53  
54      /**
55       * The language Script to be used in this context.
56       *
57       * @name Locale Script
58       */
59      public String getLocaleScript();
60  }