001/*
002 * Copyright 2011 The Kuali Foundation 
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the
005 * "License"); you may not use this file except in compliance with the
006 * License. You may obtain a copy of the License at
007 *
008 * http://www.osedu.org/licenses/ECL-2.0
009 *
010 * Unless required by applicable law or agreed to in writing,
011 * software distributed under the License is distributed on an "AS IS"
012 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
013 * or implied. See the License for the specific language governing
014 * permissions and limitations under the License.
015 */
016
017package org.kuali.student.r2.common.messages.infc;
018
019import org.kuali.student.r2.common.infc.HasKey;
020import org.kuali.student.r2.common.infc.Locale;
021
022/**
023 * Information about a message
024 *
025 * @Version 2.0
026 * @Author Sri komandur@uw.edu
027 */
028public interface Message 
029    extends HasKey {
030
031    /**
032     * The Locale.
033     *
034     * @name Locale
035     * @required
036     */
037    Locale getLocale();
038
039    /**
040     * Unique identifier for a message group
041     *
042     * @name Group Name
043     * @required
044     */
045    String getGroupName();
046
047    /**
048     * The string representation of the message. Symbols may be included within
049     * the message, but the expectation is that the caller is aware of the
050     * format of these symbols.
051     *
052     * @name Value
053     * @required
054     */
055    String getValue();
056}