1 /**
2 * Copyright 2004-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 package org.kuali.student.contract.model.test.source;
17
18 /**
19 * This is a generic context container to be used by services to pass
20 * user identity and preferences
21 *
22 * Note:
23 * 1. ISO3 standard can now be interpreted by looking at the
24 * language and country codes
25 * 2. Time zone is defined in GMT +/- hours and minutes format
26 * 3. Should Locale contain currency
27 *
28 * References:
29 * ftp://ftp.rfc-editor.org/in-notes/bcp/bcp47.txt
30 * http://download.oracle.com/javase/1.4.2/docs/api/java/util/TimeZone.html
31 *
32 * @author Kamal
33 */
34
35 public interface Context extends HasAttributes {
36
37 /**
38 * Name: Principal Id
39 *
40 * Principal Id of the currently authenticated user or the user on
41 * whom's behalf this method is being invoked.
42 *
43 * Used for authorization checking.
44 */
45 public String getPrincipalId();
46
47 /**
48 * Name: Locale Language
49 *
50 * Laguage portion of the locale information used in this context
51 */
52 public String getLocaleLanguage();
53
54 /**
55 * Name: Locale Language Variant
56 *
57 * Laguage variant portion of the locale information to be used in this context
58 */
59 public String getLocaleVariant();
60
61 /**
62 * Name: Locale Region
63 *
64 * Laguage Region portion of the locale information to be used in this context
65 */
66 public String getLocaleRegion();
67
68 /**
69 * Name: Locale Script
70 *
71 * Laguage Script to be used in this context
72 */
73 public String getLocaleScript();
74
75 /**
76 * Name: Tim Zone
77 *
78 * The time zone to be used in this context
79 */
80 public String getTimeZone();
81 }
82