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