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,
11 * software distributed under the License is distributed on an "AS IS"
12 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
13 * or 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.messages.infc;
18
19 import org.kuali.student.r2.common.infc.Locale;
20
21 /**
22 * Information about a message
23 * It has no single unique or primary key.
24 * Instead it has a composite key composed of:
25 * (1) GroupNameKey, (2) MessageKey, (3) Locale
26 *
27 * @Version 2.0
28 * @Author Sri komandur@uw.edu
29 */
30 public interface Message {
31 /**
32 * Key identifying the message within the message group.
33 *
34 * @name Key
35 * @readOnly on updates
36 * @required on updates
37 */
38 public String getMessageKey();
39
40 /**
41 * The Locale.
42 *
43 * @name Locale
44 * @required
45 */
46 Locale getLocale();
47
48 /**
49 * Unique identifier for a message group
50 *
51 * @name Group Name
52 * @required
53 */
54 String getGroupName();
55
56 /**
57 * The string representation of the message. Symbols may be included within
58 * the message, but the expectation is that the caller is aware of the
59 * format of these symbols.
60 *
61 * @name Value
62 * @required
63 */
64 String getValue();
65 }